xtray

README

什么是xtray？

---

xtray = extra + xray-core；从字面意思看，xtray是一个基于xray-core的可用性很高的免费vpn筛选客户端。

xtray同时支持vmess、vless、shadowsocks(ss)、trojan等协议；可以自动定时从免费vpn列表中筛选出可用性较高的进行使用；可以根据需要，修改配置，例如筛选vpn时的rtt阈值和goroutine数量，本地代理端口等；

xtray还提供了一个交互式shell，用于切换vpn，自动下载switchy-omega插件，geosite.dat和geoip.dat，以及控制后台xtray程序的启动和停止。

---

注意：xtray使用了free项目收集的免费vpn列表，如果你有自己的免费vpn资源，可以尝试向free贡献代码，或者通过在xtray中配置自己的free维护地址来获取自己需要的免费vpn。

交互式shell

---

• 使用xtray shell命令，可以打开xtray的交互式shell。交互式shell提供如下命令：

>>> help

Commands:
  clear        clear the screen # 清屏。
  current      Show current vpn. # 显示当前正在使用的vpn。
  exit         exit the program # 退出交互式shell。
  export       Export vpn history list. # xtray会自动将每次筛选的可用列表存入storage.db，export命令可以将这些结果导出到json文件。
  filter       Filter vpns by verifier. # 开启筛选可用vpn；如果使用filter -f，则会更新待筛选vpn列表，然后再开始筛选。如果使用filter -hs则会强制存在的可用列表历史数据拿过来筛选。
  geoinfo      Download geoip.dat and geosite.dat for xray-core. # 下载并解压xray-core需要的geoip.dat等，首次使用必须安装！！！
  help         display help
  omega        Download switchy-omega plugin for Google Chrome Browser. # 下载谷歌浏览器(基于chromium的浏览器都可用)插件，可手动添加
  restart      Restart the running xray-core client. # 重新启动xray-core客户端，如果使用restart xxx，xxx为vpn索引，则选择对应的可用vpn进行重启。
  show         Show vpn list info. # 展示vpn列表统计信息，以及可用vpn列表。可以根据可用vpn列表进行选择。
  start        Start an xray-core client. # 当没有xray-core客户端正在运行时，开启一个客户端。
  status       Show xray-core client running status. # 显示本机是否有xray-core客户端正在后台运行。
  stop         Stop the running xray-core client. # 停止本机上正在后天运行的xray-core客户端。

注意：

• 首次运行，必须要运行geoinfo命令来安装geosite.dat和geoip.dat，这是xray-core正确运行必须得配置文件！
• 首次运行，不会立即有可用vpn，可用vpn需要时间筛选，所以current为空。等待筛选完成后，show命令查看有哪些可用vpn，然后restart命令选择vpn重启；
• 关于restart命令，restart xxx（例如restart 0），即为选择第xxx号可用vpn进行重启；这时就已经切换到第xxx号vpn，可以在浏览器查看是否可用了；
• 关于filter命令，用于强制开始从原始列表中筛选可用vpn；filter -f会在筛选开始之前强制刷新一下原始列表，这样保证你的原始列表是最新的。
• omega命令会帮你下载和解压swichy-omega插件到固定文件夹，你只需要将解压之后的目录添加到浏览器插件中，就能使用插件，不会的自行百度。
• 其他命令参考上面的说明。

如果你只是使用xtray的功能，不进行开发，请使用集成了xtray所有功能的gvc

gvc已经集成了xtray的所有功能，同时还提供强大的各种辅助开发功能。 使用gvc xtray-shell或者gvc x命令，就能打开xtray的交互式shell。 gvc有已经编译好的binary，在release中即可下载安装，具体查看gvc的文档，支持MacOS、Linux、Windows。

声明

---

免责声明：本项目产生的原因在于，本人学习生活中经常要使用google和github，但是在出于某些原因无法访问，只能寻找付费vpn，但付费vpn也很容易被封，还需要花钱，比较麻烦。所以就有了本项目，对网络上的免费vpn资源进行整合。 因此，在此声明，本项目仅供学习使用，对于任何从事违法行为的活动，请自行担责。

感谢

• xray-core
• free
• goktrl