@@ -14,103 +15,94 @@
#### [中文](README.md) | [English](README_EN.md)
-功能简介：
+## Function introduction:
+
+~Convenient use in Shell environment through management script [Clash](https://github.com/Dreamacro/clash)~Support management of [Clash functions](https://lancellc.gitbook.io/clash)
~Support online import [Clash](https://github.com/Dreamacro/clash) supports sharing, subscription and configuration links
~Support configuration timing tasks, support configuration file timing updates
~Support online installation and Use local web panel to manage built-in rules
~Support routing mode, native mode and other mode switching
~Support GNOME, KDE desktop automatic configuration native mode
~Support online update
+ +## Equipment support: + +~Support various router devices based on OpenWrt or secondary custom development using OpenWrt
~Support various devices running standard Linux systems (such as Debian/CenOS/Armbian, etc.)
~Compatible with Padavan firmware (conservative mode), Pandora firmware
~Compatible with various types of devices customized and developed using the Linux kernel
——————————
~For more device support, please submit an issue or go to the TG group for feedback (the device name and the device core information returned by running uname -a must be provided)
+ +How to use: -- -~通过管理脚本在Shell环境下便捷使用[Clash](https://github.com/Dreamacro/clash)
-~支持在Shell环境下管理[Clash各种功能](https://lancellc.gitbook.io/clash)
-~支持在线导入[Clash](https://github.com/Dreamacro/clash)支持的分享、订阅及配置链接
~支持配置定时任务，支持配置文件定时更新
~支持在线安装及使用本地网页面板管理内置规则
-~支持路由模式、本机模式等多种模式切换
~支持GNOME、KDE桌面自动配置本机模式
~支持在线更新
+~Confirm that the router device has enabled SSH and obtained root privileges (Linux devices with GUI desktops can be installed using their own terminal)
~Use SSH connection tools (such as putty, JuiceSSH, system built-in terminal, etc.) router or Linux device SSH management interface or terminal interface, and switch to the root user
~Confirm that the curl or wget download tool has been installed on the device. If not installed, please [refer to here](https://www.howtoforge.com/install-curl-in-linux) for LInux devices to install curl. For devices based on OpenWrt (Xiaomi official system, Pandora, Gaoke, etc.), please Use the following command to install curl:
-设备支持： --- - -~支持各种基于OpenWrt或使用OpenWrt二次定制开发的路由器设备
-~支持各种运行标准Linux系统（如Debian/CenOS/Armbian等）的设备
~兼容Padavan固件（保守模式）、潘多拉固件
~兼容各类使用Linux内核定制开发的各类型设备
- -——————————
-~更多设备支持，请提issue或前往TG群反馈（需提供设备名称及运行uname -a返回的设备核心信息）
- -使用方式： --- -~确认路由器设备已经开启SSH并获取root权限（带GUI桌面的Linux设备可使用自带终端安装）
-~使用SSH连接工具（如putty，JuiceSSH，系统自带终端等）路由器或Linux设备的SSH管理界面或终端界面，并切换到root用户
-~确认设备已经安装curl或者wget下载工具。如未安装，LInux设备请[参考此处](https://www.howtoing.com/install-curl-in-linux)安装curl，基于OpenWrt（小米官方系统、潘多拉、高恪等）的设备请使用如下命令安装curl：
- -```shell +```sh opkg update && opkg install curl ``` -~之后在SSH界面执行如下安装命令，并按照后续提示完成安装
+~ Then execute the following installation commands on the SSH interface, and follow the subsequent prompts to complete the installation
-~**使用curl安装**：
+##### ~Use curl:
```Shell -#Release版本-github直连 +#Release version - by github sh -c "$(curl -kfsSl --resolve raw.githubusercontent.com:443:199.232.68.133 https://raw.githubusercontent.com/juewuy/ShellClash/master/install.sh)" && source /etc/profile &> /dev/null -#Release版本-jsdelivrCDN源 +#Release version - by jsdelivrCDN sh -c "$(curl -kfsSl https://cdn.jsdelivr.net/gh/juewuy/ShellClash@master/install.sh)" && source /etc/profile &> /dev/null -#Test版本-github直连 +#Test version - by github sh -c "$(curl -kfsSl --resolve raw.githubusercontent.com:443:199.232.68.133 https://raw.githubusercontent.com/juewuy/ShellClash/master/install.sh)" -s 1 && source /etc/profile &> /dev/null ``` -~**使用wget安装**：
+##### ~Use wget：
```sh -#Release版本-jsdelivrCDN源 +#Release version - by jsdelivrCDN wget -q --no-check-certificate -O /tmp/install.sh https://cdn.jsdelivr.net/gh/juewuy/ShellClash@master/install.sh && sh /tmp/install.sh && source /etc/profile &> /dev/null ``` -~**非root用户安装后**请额外执行以下命令以读取环境变量：
+~**After installation by non-root users**, please execute the following additional commands to read environment variables:
```shell source ~/.bashrc &> /dev/null ``` -~安装完成管理脚本后，执行如下命令以**运行管理脚本**
+~After installing the management script, execute the following command to **run the management script**
```Shell -clash #正常模式运行 -clash -h #脚本帮助及说明 -clash -t #测试模式运行 +clash #normal mode +clash -h #help +clash -t #test mode ``` -~**运行时的额外依赖**：
+~**Additional dependencies at runtime**：
-`大部分的设备/系统都已经预装了以下的大部分依赖，使用时如无影响可以无视之` +``` +Most of the equipment/systems are pre-installed with most of the following dependencies, you can ignore them if there is no impact when you use them. +``` ```sh -bash/ash 必须 全部缺少时无法安装及运行脚本 -curl/wget 必须 全部缺少时无法在线安装及更新，无法使用节点保存功能 -iptables 重要 缺少时只能使用纯净模式 -systemd/rc.common 一般 全部缺少时只能使用保守模式 -iptables-mod-nat 一般 缺少时无法使用redir模式，混合模式 -ip6tables-mod-nat 较低 缺少时影响redir模式，混合模式对ipv6的支持 -crontab 较低 缺少时无法启用定时任务功能 -net-tools 极低 缺少时无法正常检测端口占用 -ubus/iproute-doc 极低 缺少时无法正常获取本机host地址 +bash/ash necessary Cannot install and run scripts when all are missing +curl/wget necessary When all are missing, it cannot be installed and updated online +iptables important Only use pure mode when missing +systemd/rc.common general Only use conservative mode when all are missing +iptables-mod-nat general Cannot use redir mode, mixed mode when missing +ip6tables-mod-nat lower Affects redir mode when missing, mixed mode support for ipv6 +crontab lower Cannot enable timing task function when missing +net-tools minimal Cannot detect port occupancy normally when missing +ubus/iproute-doc minimal The host address of the machine cannot be obtained normally when missing ``` -更新日志： --- +## Update log: -### [点击查看](https://github.com/juewuy/ShellClash/releases) +### [Click to view](https://github.com/juewuy/ShellClash/releases) -交流反馈： --- -### [TG讨论组](https://t.me/clashfm) +## Exchange feedback: -相关Q&A： --- +### [TG Discussion Group](https://t.me/clashfm) -### [详见博客](https://juewuy.github.io) +## Related Q&A: -## 捐赠此项目： +### [See blog for details](https://juewuy.github.io) -### [前往页面](https://juewuy.github.io/yOF4Yf06Q/) +## Donate this project + +### [Go to page](https://juewuy.github.io/yOF4Yf06Q/) + +## Friendly promotion: + +### [Top 8K Airport-Dler](https://dler.best/auth/register?affid=89698) -友情推广： --- -### [顶级8K专线机场-墙洞](https://dler.best/auth/register?affid=89698) diff --git a/README_CN.md b/README_CN.md new file mode 100644 index 0000000..4374132 --- /dev/null +++ b/README_CN.md @@ -0,0 +1,116 @@ +
+ 
+
ShellClash
+
+
+###### 
+ + +#### [中文](README_CN.md) | [English](README.md) + +功能简介： +-- + +~通过管理脚本在Shell环境下便捷使用[Clash](https://github.com/Dreamacro/clash)
+~支持在Shell环境下管理[Clash各种功能](https://lancellc.gitbook.io/clash)
+~支持在线导入[Clash](https://github.com/Dreamacro/clash)支持的分享、订阅及配置链接
~支持配置定时任务，支持配置文件定时更新
~支持在线安装及使用本地网页面板管理内置规则
+~支持路由模式、本机模式等多种模式切换
~支持GNOME、KDE桌面自动配置本机模式
~支持在线更新
+ +设备支持： +-- + +~支持各种基于OpenWrt或使用OpenWrt二次定制开发的路由器设备
+~支持各种运行标准Linux系统（如Debian/CenOS/Armbian等）的设备
~兼容Padavan固件（保守模式）、潘多拉固件
~兼容各类使用Linux内核定制开发的各类型设备
+ +——————————
+~更多设备支持，请提issue或前往TG群反馈（需提供设备名称及运行uname -a返回的设备核心信息）
+ +使用方式： +-- +~确认路由器设备已经开启SSH并获取root权限（带GUI桌面的Linux设备可使用自带终端安装）
+~使用SSH连接工具（如putty，JuiceSSH，系统自带终端等）路由器或Linux设备的SSH管理界面或终端界面，并切换到root用户
+~确认设备已经安装curl或者wget下载工具。如未安装，LInux设备请[参考此处](https://www.howtoing.com/install-curl-in-linux)安装curl，基于OpenWrt（小米官方系统、潘多拉、高恪等）的设备请使用如下命令安装curl：
+ +```shell +opkg update && opkg install curl +``` + +~之后在SSH界面执行如下安装命令，并按照后续提示完成安装
+ +~**使用curl安装**：
+ +```Shell +#Release版本-github直连 +sh -c "$(curl -kfsSl --resolve raw.githubusercontent.com:443:199.232.68.133 https://raw.githubusercontent.com/juewuy/ShellClash/master/install.sh)" && source /etc/profile &> /dev/null +#Release版本-jsdelivrCDN源 +sh -c "$(curl -kfsSl https://cdn.jsdelivr.net/gh/juewuy/ShellClash@master/install.sh)" && source /etc/profile &> /dev/null +#Test版本-github直连 +sh -c "$(curl -kfsSl --resolve raw.githubusercontent.com:443:199.232.68.133 https://raw.githubusercontent.com/juewuy/ShellClash/master/install.sh)" -s 1 && source /etc/profile &> /dev/null +``` + +~**使用wget安装**：
+ +```sh +#Release版本-jsdelivrCDN源 +wget -q --no-check-certificate -O /tmp/install.sh https://cdn.jsdelivr.net/gh/juewuy/ShellClash@master/install.sh && sh /tmp/install.sh && source /etc/profile &> /dev/null +``` + +~**非root用户安装后**请额外执行以下命令以读取环境变量：
+ +```shell +source ~/.bashrc &> /dev/null +``` + +~安装完成管理脚本后，执行如下命令以**运行管理脚本**
+ +```Shell +clash #正常模式运行 +clash -h #脚本帮助及说明 +clash -t #测试模式运行 +``` + +~**运行时的额外依赖**：
+ +`大部分的设备/系统都已经预装了以下的大部分依赖，使用时如无影响可以无视之` + +```sh +bash/ash 必须 全部缺少时无法安装及运行脚本 +curl/wget 必须 全部缺少时无法在线安装及更新，无法使用节点保存功能 +iptables 重要 缺少时只能使用纯净模式 +systemd/rc.common 一般 全部缺少时只能使用保守模式 +iptables-mod-nat 一般 缺少时无法使用redir模式，混合模式 +ip6tables-mod-nat 较低 缺少时影响redir模式，混合模式对ipv6的支持 +crontab 较低 缺少时无法启用定时任务功能 +net-tools 极低 缺少时无法正常检测端口占用 +ubus/iproute-doc 极低 缺少时无法正常获取本机host地址 +``` + + + +更新日志： +-- + +### [点击查看](https://github.com/juewuy/ShellClash/releases) + +交流反馈： +-- +### [TG讨论组](https://t.me/clashfm) + +相关Q&A： +-- + +### [详见博客](https://juewuy.github.io) + +## 捐赠此项目： + +### [前往页面](https://juewuy.github.io/yOF4Yf06Q/) + +友情推广： +-- +### [顶级8K专线机场-墙洞](https://dler.best/auth/register?affid=89698) diff --git a/README_EN.md b/README_EN.md deleted file mode 100644 index 3b8157d..0000000 --- a/README_EN.md +++ /dev/null @@ -1,108 +0,0 @@ -
-
-
ShellClash
-
-
-
-###### - -#### [中文](README.md) | [English](README_EN.md) - -## Function introduction: - -~Convenient use in Shell environment through management script [Clash](https://github.com/Dreamacro/clash)
~Support management of [Clash functions](https://lancellc.gitbook.io/clash)
~Support online import [Clash](https://github.com/Dreamacro/clash) supports sharing, subscription and configuration links
~Support configuration timing tasks, support configuration file timing updates
~Support online installation and Use local web panel to manage built-in rules
~Support routing mode, native mode and other mode switching
~Support GNOME, KDE desktop automatic configuration native mode
~Support online update
- -## Equipment support: - -~Support various router devices based on OpenWrt or secondary custom development using OpenWrt
~Support various devices running standard Linux systems (such as Debian/CenOS/Armbian, etc.)
~Compatible with Padavan firmware (conservative mode), Pandora firmware
~Compatible with various types of devices customized and developed using the Linux kernel
——————————
~For more device support, please submit an issue or go to the TG group for feedback (the device name and the device core information returned by running uname -a must be provided)
- -How to use: --- - -~Confirm that the router device has enabled SSH and obtained root privileges (Linux devices with GUI desktops can be installed using their own terminal)
~Use SSH connection tools (such as putty, JuiceSSH, system built-in terminal, etc.) router or Linux device SSH management interface or terminal interface, and switch to the root user
~Confirm that the curl or wget download tool has been installed on the device. If not installed, please [refer to here](https://www.howtoforge.com/install-curl-in-linux) for LInux devices to install curl. For devices based on OpenWrt (Xiaomi official system, Pandora, Gaoke, etc.), please Use the following command to install curl:
- -```sh -opkg update && opkg install curl -``` - -~ Then execute the following installation commands on the SSH interface, and follow the subsequent prompts to complete the installation
- -##### ~Use curl:
- -```Shell -#Release version - by github -sh -c "$(curl -kfsSl --resolve raw.githubusercontent.com:443:199.232.68.133 https://raw.githubusercontent.com/juewuy/ShellClash/master/install.sh)" && source /etc/profile &> /dev/null -#Release version - by jsdelivrCDN -sh -c "$(curl -kfsSl https://cdn.jsdelivr.net/gh/juewuy/ShellClash@master/install.sh)" && source /etc/profile &> /dev/null -#Test version - by github -sh -c "$(curl -kfsSl --resolve raw.githubusercontent.com:443:199.232.68.133 https://raw.githubusercontent.com/juewuy/ShellClash/master/install.sh)" -s 1 && source /etc/profile &> /dev/null -``` - -##### ~Use wget：
- -```sh -#Release version - by jsdelivrCDN -wget -q --no-check-certificate -O /tmp/install.sh https://cdn.jsdelivr.net/gh/juewuy/ShellClash@master/install.sh && sh /tmp/install.sh && source /etc/profile &> /dev/null -``` - -~**After installation by non-root users**, please execute the following additional commands to read environment variables:
- -```shell -source ~/.bashrc &> /dev/null -``` - -~After installing the management script, execute the following command to **run the management script**
- -```Shell -clash #normal mode -clash -h #help -clash -t #test mode -``` - -~**Additional dependencies at runtime**：
- -``` -Most of the equipment/systems are pre-installed with most of the following dependencies, you can ignore them if there is no impact when you use them. -``` - -```sh -bash/ash necessary Cannot install and run scripts when all are missing -curl/wget necessary When all are missing, it cannot be installed and updated online -iptables important Only use pure mode when missing -systemd/rc.common general Only use conservative mode when all are missing -iptables-mod-nat general Cannot use redir mode, mixed mode when missing -ip6tables-mod-nat lower Affects redir mode when missing, mixed mode support for ipv6 -crontab lower Cannot enable timing task function when missing -net-tools minimal Cannot detect port occupancy normally when missing -ubus/iproute-doc minimal The host address of the machine cannot be obtained normally when missing -``` - - - -## Update log: - -### [Click to view](https://github.com/juewuy/ShellClash/releases) - -## Exchange feedback: - -### [TG Discussion Group](https://t.me/clashfm) - -## Related Q&A: - -### [See blog for details](https://juewuy.github.io) - -## Donate this project - -### [Go to page](https://juewuy.github.io/yOF4Yf06Q/) - -## Friendly promotion: - -### [Top 8K Airport-Dler](https://dler.best/auth/register?affid=89698) -