2018-08-08 22:00:04 +08:00
< h1 align = "center" >
< img src = "https://github.com/Dreamacro/clash/raw/master/docs/logo.png" alt = "Clash" width = "200" >
< br >
ClashX
< br >
< / h1 >
2018-06-14 17:38:27 +08:00
2018-08-08 22:00:04 +08:00
A rule based proxy For Mac base on [Clash ](https://github.com/Dreamacro/clash ).
2018-08-14 17:22:58 +08:00
2018-06-14 17:38:27 +08:00
2018-11-09 10:12:26 +08:00
## Features
2018-06-14 17:38:27 +08:00
2018-11-09 10:12:26 +08:00
- HTTP/HTTPS and SOCKS protocol
- Surge like configuration
- GeoIP rule support
- Support Vmess/Shadowsocks/Socks5
2019-05-31 13:00:43 +08:00
- Support for Netfilter TCP redirect
2018-08-08 22:00:04 +08:00
2018-11-09 10:12:26 +08:00
## Install
2018-06-14 17:38:27 +08:00
2020-04-24 21:08:29 +08:00
You can download from [Release ](https://github.com/yichengchen/clashX/releases ) page
2020-04-25 12:06:02 +08:00
Download ClashX Pro With enhanced mode and other advance feature at [AppCenter ](https://install.appcenter.ms/users/clashx/apps/clashx-pro/distribution_groups/public ) for free permanently.
2018-06-14 17:38:27 +08:00
2019-02-11 16:37:30 +08:00
## Build
2020-03-13 18:17:34 +08:00
- Make sure have python3 and golang installed in your computer.
2019-10-02 21:43:18 +08:00
- Download deps
2019-02-11 16:37:30 +08:00
```
2019-10-02 21:43:18 +08:00
bash install_dependency.sh
2019-02-11 16:37:30 +08:00
```
2020-03-13 18:17:34 +08:00
2019-02-11 16:37:30 +08:00
- Build and run.
2018-11-09 10:12:26 +08:00
## Config
The default configuration directory is `$HOME/.config/clash`
2020-02-25 09:41:51 +08:00
The default name of the configuration file is `config.yaml` . You can use your custom config name and switch config in menu `Config` section.
2019-02-11 16:37:30 +08:00
2019-09-15 21:13:43 +08:00
2020-04-24 21:08:29 +08:00
Checkout [Clash ](https://github.com/Dreamacro/clash ) or [SS-Rule-Snippet for Clash ](https://github.com/Hackl0us/SS-Rule-Snippet/blob/master/LAZY_RULES/clash.yaml ) or [lancellc's gitbook ](https://lancellc.gitbook.io/clash/ ) for more detail.
2019-02-11 16:37:30 +08:00
2019-03-31 16:38:00 +08:00
## Advance Config
2020-04-24 21:08:29 +08:00
### Change the ports of ClashX
Please modify the `config.yaml` file generated by ClashX, not the other config file you created or downloaded. The `General` section settings in your custom config file would be ignored.
2019-03-31 16:38:00 +08:00
### Change your status menu icon
2019-10-02 21:43:18 +08:00
Place your icon file in the `~/.config/clash/menuImage.png` then restart ClashX
2019-08-21 16:52:50 +08:00
2019-03-31 16:38:00 +08:00
### Change default system ignore list.
2019-08-28 18:00:46 +08:00
- Download sample plist in the [Here ](proxyIgnoreList.plist ) and place in the
2019-03-31 16:38:00 +08:00
2019-08-21 16:52:50 +08:00
```
~/.config/clash/proxyIgnoreList.plist
```
2019-03-31 16:38:00 +08:00
2019-08-21 16:52:50 +08:00
- Edit the `proxyIgnoreList.plist` to set up your own proxy ignore list
2019-07-30 21:03:24 +08:00
### Use url scheme to import remote config.
2019-03-31 16:38:00 +08:00
2019-08-21 16:52:50 +08:00
- Using url scheme describe below
```
2019-10-01 16:40:52 +08:00
clash://install-config?url=http%3A%2F%2Fexample.com& name=example
2019-08-21 16:52:50 +08:00
```
2018-06-14 17:38:27 +08:00
2019-10-02 21:43:18 +08:00
