{"id":15157400,"url":"https://github.com/Watfaq/clash-rs","last_synced_at":"2025-09-30T07:30:35.306Z","repository":{"id":195533300,"uuid":"539085458","full_name":"Watfaq/clash-rs","owner":"Watfaq","description":"custom protocol network proxy","archived":false,"fork":false,"pushed_at":"2024-10-28T04:45:51.000Z","size":30543,"stargazers_count":787,"open_issues_count":20,"forks_count":62,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-10-29T17:36:47.620Z","etag":null,"topics":["clash","clash-rs","clashrs","hsalc","ios","proxy","rust","vpn"],"latest_commit_sha":null,"homepage":"https://watfaq.gitbook.io/clashrs-user-manual/","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Watfaq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-09-20T16:25:24.000Z","updated_at":"2024-10-29T04:27:29.000Z","dependencies_parsed_at":"2023-12-30T20:27:28.875Z","dependency_job_id":"2585d1b1-62cb-453d-b892-b6723c5ff7f6","html_url":"https://github.com/Watfaq/clash-rs","commit_stats":{"total_commits":658,"total_committers":13,"mean_commits":50.61538461538461,"dds":0.5364741641337386,"last_synced_commit":"9e580a6ede05ba8784400645bc7c4f7c506b4bb1"},"previous_names":["watfaq/clash-rs"],"tags_count":35,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Watfaq%2Fclash-rs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Watfaq%2Fclash-rs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Watfaq%2Fclash-rs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Watfaq%2Fclash-rs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Watfaq","download_url":"https://codeload.github.com/Watfaq/clash-rs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234712808,"owners_count":18875517,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["clash","clash-rs","clashrs","hsalc","ios","proxy","rust","vpn"],"created_at":"2024-09-26T20:00:50.236Z","updated_at":"2025-09-30T07:30:35.301Z","avatar_url":"https://github.com/Watfaq.png","language":"Rust","funding_links":[],"categories":["Rust"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://ant.design\"\u003e\n    \u003cimg width=\"200\" src=\"https://github.com/Watfaq/clash-rs/assets/543405/76122ef1-eac8-478a-8ba4-ca5e54f8e272\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003eClashRS\u003c/h1\u003e\n\n\u003cdiv align=\"center\"\u003e\n\nA custom protocol, rule based network proxy software.\n\n[![CI](https://github.com/Watfaq/clash-rs/actions/workflows/ci.yml/badge.svg)](https://github.com/Watfaq/clash-rs/actions/workflows/ci.yml)\n[![codecov](https://codecov.io/gh/Watfaq/clash-rs/graph/badge.svg?token=ZQK5WB63KR)](https://codecov.io/gh/Watfaq/clash-rs)\n\n\u003c/div\u003e\n\n## ✨ Features\n\n- 🌈 Flexible traffic routing rules based off source/destination IP/Domain/GeoIP etc.\n- 📦 Local anti spoofing DNS with support of UDP/TCP/DoH/DoT remote, and expose it as a local UDP/TCP/DoH/DoT server.\n- 🛡 Run as an HTTP/Socks5 proxy, or utun device as a home network gateway.\n- ⚙️ Shadowsocks/Trojan/Vmess/Wireguard(userspace)/Tor/Tuic/Socks5(TCP/UDP) outbound support with different underlying trasports(gRPC/TLS/H2/WebSocket/etc.).\n- 🌍 Dynamic remote rule/proxy loader.\n- 🎵 Tracing with Jaeger\n\n## 🖥 Environment Support\n\n- Linux\n- macOS\n- Windows\n  - You need to copy the [wintun.dll](https://wintun.net/) file which matches your architecture to the same directory as your executable and run you program as administrator.\n- iOS - [TestFlight](https://testflight.apple.com/join/cLy4Ub5C)\n\n## 📦 Install\n\n### Use With GUI\n\nhttps://github.com/LibNyanpasu/clash-nyanpasu\n\n### Download Prebuilt Binary\n\nCan be found at https://github.com/Watfaq/clash-rs/releases\n\n### Docker Image\n\nhttps://github.com/Watfaq/clash-rs/pkgs/container/clash-rs\n\n### Local Build\n\nDependencies\n\n* cmake (3.29 or newer)\n* libclang([LLVM](https://github.com/llvm/llvm-project/releases/tag/llvmorg-16.0.4))\n* [nasm](https://www.nasm.us/pub/nasm/releasebuilds/2.16/win64/) (Windows)\n* protoc(for geodata proto generation)\n* pre-commit\n  * [pre-commit](https://pre-commit.com/) for managing git hooks\n\n```\n$ pipx install pre-commit\n$ pre-commit install\n\n$ cargo build\n```\n\n## 🔨 Usage\n\n### Example Config\n\nsample.yaml:\n\n```yaml\nport: 7890\n```\n\n### Run\n```shell\n-\u003e % ./target/debug/clash -c sample.yaml\n```\n\n### Help\n```shell\n-\u003e % ./target/debug/clash-rs -h\nUsage: clash-rs [OPTIONS]\n\nOptions:\n  -d, --directory \u003cDIRECTORY\u003e\n  -c, --config \u003cFILE\u003e          Specify configuration file [default: config.yaml] [short aliases: f]\n  -t, --test-config            Test configuration and exit\n  -v, --version                Print clash-rs version and exit [short aliases: V]\n  -l, --log-file \u003cLOG_FILE\u003e    Additionally log to file\n      --help-improve           Enable crash report to help improve clash\n  -h, --help                   Print help\n```\n\n## FFI\n\n### Compile for apple platforms\n\nTo create a framework for iOS and macOS platforms\n\n```shell\ngit clone https://github.com/Watfaq/clash-rs.git\ncd clash-rs\nchmod +x scripts/build_apple.sh\n./scripts/build_apple.sh\n```\n\nThis command will generate a `clashrs.xcframework` file in the `build` directory.\n\n## 🔗 Links\n\n- [Documentation](https://watfaq.gitbook.io/clashrs-user-manual/)\n- [Config Reference](https://watfaq.github.io/clash-rs/)\n- [Roadmap](https://github.com/Watfaq/clash-rs/issues/59)\n\n\n## 🤝 Contributing\n\n- [CONTRIBUTING.md](CONTRIBUTING.md)\n- [Telegram User Group](https://t.me/thisisnotclash)\n\n## ❤️ Inspired By\n- [Dreamacro/clash](https://github.com/Dreamacro/clash)\n- [eycorsican/leaf](https://github.com/eycorsican/leaf)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FWatfaq%2Fclash-rs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FWatfaq%2Fclash-rs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FWatfaq%2Fclash-rs/lists"}