ClashRS

✨ Features

• 🌈 Flexible traffic routing rules based off source/destination IP/Domain/GeoIP etc.
• 📦 Local anti spoofing DNS with support of UDP/TCP/DoH/DoT remote, and expose it as a local UDP/TCP/DoH/DoT server.
• ⚙️ AnyTLS/Hysteria2/Shadowquic/Shadowsocks/Socks5(TCP/UDP)/SSH/Tailscale/tor(onion)/Trojan/Tuic/VLess/Vmess/Wireguard(userspace) outbound support with different underlying transports(gRPC/TLS/H2/WebSocket/etc.).
• 🔀 Multiple inbound modes: HTTP, SOCKS5, Mixed, Shadowsocks, AnyTLS, Redir, TProxy, and TUN (utun) for transparent proxying.
• 🌍 Dynamic remote rule/proxy loader.
• 🎵 Tracing with Jaeger

📡 Protocol Support

Inbounds

Outbounds

🖥 Environment Support

• Linux
• macOS
• Windows
  • You need to copy the wintun.dll file which matches your architecture to the same directory as your executable and run your program as administrator.
• iOS
  • 
  • TestFlight Access: TestFlight

💰 Sponsors

• Fast Access Cloud

📦 Install

Use With GUI

https://github.com/LibNyanpasu/clash-nyanpasu

Download Prebuilt Binary

Can be found at https://github.com/Watfaq/clash-rs/releases

Docker Image

https://github.com/Watfaq/clash-rs/pkgs/container/clash-rs

Local Build

Dependencies

• cmake (3.29 or newer)
• libclang(LLVM)
• nasm (Windows)
• protoc(for geodata proto generation)
• pre-commit for managing git hooks

$ pipx install pre-commit
$ pre-commit install

$ cargo build

🔨 Usage

Example Config

sample.yaml:

port: 7890

Run

-> % ./target/debug/clash-rs -c sample.yaml

Help

-> % ./target/debug/clash-rs -h
Usage: clash-rs [OPTIONS]

Options:
  -d, --directory <DIRECTORY>      Set working directory (config-relative paths resolve from here)
  -c, --config <FILE>              Specify configuration file [default: config.yaml] [short aliases: f]
  -t, --test-config                Test configuration and exit
  -v, --version                    Print clash-rs version and exit [short aliases: V]
  -l, --log-file <LOG_FILE>        Additionally log to file
      --help-improve               Enable crash report to help improve clash
      --controller-ipc <IPC_PATH>  Specify the IPC path for the controller [aliases: --ext-ctl-pipe, --ext-ctl-unix]
      --compatibility              Enable compatibility mode for mihomo-consistent behavior
  -h, --help                       Print help

FFI

Compile for apple platforms

To create a framework for iOS and macOS platforms

git clone https://github.com/Watfaq/clash-rs.git
cd clash-rs
chmod +x scripts/build_apple.sh
./scripts/build_apple.sh

This command will generate a clashrs.xcframework file in the build directory.

🔗 Links

• Documentation
• Config Reference
• Roadmap

🤝 Contributing

• CONTRIBUTING.md
• Telegram User Group

❤️ Inspired By

• Dreamacro/clash
• eycorsican/leaf