Skip to content

Latest commit

 

History

History
97 lines (60 loc) · 2.23 KB

README.md

File metadata and controls

97 lines (60 loc) · 2.23 KB
Raw

Clash-node is a node.js project, you can use this clash-node subscrible the proxies from the vendor's url, and run clash in the terminal. Clash-node is based on Dreamacro/clash, aimed at making it convenient for linux user's using vmess and shadowsocks.

Clash-node now is fully open source, anyone has any ideas with this repo can contact me.

Current version

Current version is 0.1.1.

UPDATE: Update start and stop command

Features

  • It runs clash in terminal
  • Support subscrible proxies from url(Now only support vmess)
  • Fully configured, use by only download it

Requirements

Node

Clash-node uses nodejs as runtime environment, install node first.

It is recommended that use nvm as Node version manager.

It is needed install node with npm.

In China npm maybe slow, you can choose cnpm.

Install

Now can only install from source

git clone https://github.com/kingrongH/clash-node
cd clash-node
npm install
npm build

Usage

In this repo dir you can

For subscrible

Run the command below, and then follow the instructions to add a subscrible url and the proxies from the subscrible

node clash-node addSub

It looks like this: subscrible

Update the subscrible you have added before by ruuning command below:

node clash-node updateSub

For run clash

After update the subscrible from the url, you may want to start using this proxies now.

node clash-node start

Select a proxy to use

You can change the proxy by change the followling command.

node clash-node selectProxy

And follow the step to choose the proxy you want to use.

Config

config some the config except Proxy, Proxy Group and Rule in ./config/config.yml

Which is the same as clash's config, see Dreamacro/clashh for more infomation.

Thanks

Dreamacro/clash

TODO

  • Add ss proxies support
  • Add proxy control
  • Add single proxy add function
  • Different system support
  • Log system
  • Commadnline completion