Clashctl

About

Easy-to-use TUI & CLI to interact with Clash RESTful API.

Getting Started

```bash $ clashctl proxy list

TYPE DELAY NAME

selector - All

URLTest         -       Auto-All
ShadowsocksR    19      SomeProxy-1
Vmess           177     SomeProxy-2
Vmess           137     SomeProxy-3
Shadowsocks     143     SomeProxy-4

```

Features

• Pretty terminal UI
• Change proxies
• Display proxies, with filter and sorting supported, in both plain and grouped mode
• Store and use multiple servers
• Generate completion script (by clap_generate)
• Manage multiple servers
• TUI
  • Status (info & traffic)
  • Logs

TODO

• [ ] Cli
  • [x] Manage servers
  • [x] Sort proxies
  • [ ] More features
• [ ] TUI
  • [x] Status Panel
  • [x] Proxies Panel
  • [ ] Update proxy
  • [ ] Test latency
  • [ ] Sort by {Original, LatencyAsc, LatencyDsc, NameAsc, NameDsc}
  • [x] Rules Panel
  • [x] Connections Panel
  • [ ] Sort
  • [x] Log Panel
  • [x] Debug Panel
  • [ ] Config Panel
  • [ ] Update clash configs
  • [ ] Update clashctl configs
  • [ ] Search
  • [ ] (Maybe?) mouse support

Installing

Use Cargo

bash $ cargo install clashctl

Compile from source

bash $ git clone https://github.com/George-Miao/clashctl.git $ cd clashctl $ cargo install --features cli --path .

Prerequisites

You will need rust environment (Cargo & rustc) to compile and install

MSRV

Minimum supported rust version is 1.56.0

Test with cargo-msrv

Usage

Use the CLI

``` clashctl

George Miao gm@miao.dev

CLI used to interact with Clash RESTful API

USAGE: clashctl [OPTIONS]

OPTIONS: -c, --config Path of config file. Default to ~/.config/clashctl/config.ron -h, --help Print help information -t, --timeout Timeout of requests, in ms [default: 2000] -v, --verbose Verbosity. Default: INFO, -v DEBUG, -vv TRACE -V, --version Print version information

SUBCOMMANDS: completion Generate auto-completion scripts help Print this message or the help of the given subcommand(s) proxy Interacting with proxies server Interacting with servers ```

Use as a crate

```toml

cargo.toml

[dependencies] clashctl = "*" ```

Then in your project:

```rust use clashctl::Clash;

fn test() { let clash = Clash::builder("http://example.com:9090").unwrap().build(); println!("Clash version is {:?}", clash.get_version().unwrap()) } ```