2018-06-23 00:44:28 +08:00
< h1 align = "center" >
< img src = "https://github.com/Dreamacro/clash/raw/master/docs/logo.png" alt = "Clash" width = "200" >
2019-02-11 15:55:17 +08:00
< br > Clash< br >
2018-06-23 00:44:28 +08:00
< / h1 >
2018-12-11 00:25:05 +08:00
< h4 align = "center" > A rule-based tunnel in Go.< / h4 >
2018-06-23 00:44:28 +08:00
< p align = "center" >
2019-12-08 12:34:05 +08:00
< a href = "https://github.com/Dreamacro/clash/actions" >
< img src = "https://img.shields.io/github/workflow/status/Dreamacro/clash/Go?style=flat-square" alt = "Github Actions" >
< / a >
2018-06-23 00:44:28 +08:00
< a href = "https://goreportcard.com/report/github.com/Dreamacro/clash" >
2019-02-11 15:55:17 +08:00
< img src = "https://goreportcard.com/badge/github.com/Dreamacro/clash?style=flat-square" >
2018-06-23 00:44:28 +08:00
< / a >
2021-09-20 17:22:40 +08:00
< img src = "https://img.shields.io/github/go-mod/go-version/Dreamacro/clash?style=flat-square" >
2018-06-23 00:44:28 +08:00
< a href = "https://github.com/Dreamacro/clash/releases" >
< img src = "https://img.shields.io/github/release/Dreamacro/clash/all.svg?style=flat-square" >
< / a >
2021-09-20 17:22:40 +08:00
< a href = "https://github.com/Dreamacro/clash/releases/tag/premium" >
< img src = "https://img.shields.io/badge/release-Premium-00b4f0?style=flat-square" >
< / a >
2018-06-23 00:44:28 +08:00
< / p >
2018-06-10 22:50:03 +08:00
## Features
2020-06-28 10:39:30 +08:00
- Local HTTP/HTTPS/SOCKS server with authentication support
2022-08-27 12:16:25 +08:00
- Shadowsocks(R), VMess, Trojan, Snell, SOCKS5, HTTP(S) outbound support
- Built-in [fake-ip ](https://www.rfc-editor.org/rfc/rfc3089 ) DNS server that aims to minimize DNS pollution attack impact. DoH/DoT upstream supported.
- Rules based off domains, GEOIP, IP-CIDR or process names to route packets to different destinations
- Proxy groups allow users to implement powerful rules. Supports automatic fallback, load balancing or auto select proxy based off latency
- Remote providers, allowing users to get proxy lists remotely instead of hardcoding in config
- Transparent proxy: Redirect TCP and TProxy TCP/UDP with automatic route table/rule management
- Hot-reload via the comprehensive HTTP RESTful API controller
2018-08-14 18:06:56 +08:00
2022-08-27 12:16:25 +08:00
## Premium
2020-12-27 00:14:24 +08:00
2022-08-27 12:16:25 +08:00
Premium core is proprietary. You can find their release notes and pre-built binaries [here ](https://github.com/Dreamacro/clash/releases/tag/premium ).
2020-12-27 00:14:24 +08:00
2022-09-27 14:22:21 +08:00
- gvisor/system stack TUN device on macOS, Linux and Windows ([ref](https://github.com/Dreamacro/clash/wiki/Clash-Premium-Features#tun-device))
- Policy routing with [Scripts ](https://github.com/Dreamacro/clash/wiki/Clash-Premium-Features#script )
- Load your rules with [Rule Providers ](https://github.com/Dreamacro/clash/wiki/Clash-Premium-Features#rule-providers )
2022-08-27 12:16:25 +08:00
- Monitor Clash usage with a built-in profiling engine. ([Dreamacro/clash-tracing](https://github.com/Dreamacro/clash-tracing))
2019-04-15 19:05:01 +08:00
2022-08-27 12:16:25 +08:00
## Getting Started
Documentations are available at [GitHub Wiki ](https://github.com/Dreamacro/clash/wiki ).
2020-12-27 00:14:24 +08:00
2021-06-13 23:11:49 +08:00
## Development
2022-08-27 12:16:25 +08:00
If you want to build a Go application that uses Clash as a library, check out the [GitHub Wiki ](https://github.com/Dreamacro/clash/wiki/Using-Clash-in-your-Golang-program ).
2021-06-13 23:11:49 +08:00
2020-03-20 12:35:30 +08:00
## Credits
2018-08-12 04:22:14 +08:00
2020-06-28 10:39:30 +08:00
* [riobard/go-shadowsocks2 ](https://github.com/riobard/go-shadowsocks2 )
* [v2ray/v2ray-core ](https://github.com/v2ray/v2ray-core )
2021-09-20 17:22:40 +08:00
* [WireGuard/wireguard-go ](https://github.com/WireGuard/wireguard-go )
2018-09-16 23:08:04 +08:00
2018-07-15 22:32:20 +08:00
## License
2018-08-12 04:22:14 +08:00
2020-06-28 10:39:30 +08:00
This software is released under the GPL-3.0 license.
2018-07-15 22:32:20 +08:00
[![FOSSA Status ](https://app.fossa.io/api/projects/git%2Bgithub.com%2FDreamacro%2Fclash.svg?type=large )](https://app.fossa.io/projects/git%2Bgithub.com%2FDreamacro%2Fclash?ref=badge_large)