> For the complete documentation index, see [llms.txt](https://watfaq.gitbook.io/clashrs-user-manual/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://watfaq.gitbook.io/clashrs-user-manual/readme.md).

# Welcome to ClashRS User Manual

{% hint style="info" %}
This software is still under it's prerelease. Please report any missing/broken features if you'd like to :thumbsup:
{% endhint %}

{% hint style="info" %}
**Disclaimer:**

* This manual contains AI generated content and may not be 100% accurate.
  {% endhint %}

## Overview

ClashRS is a network proxy software that you can use to control how you want to divert your internet traffic through different proxy servers with flexible rules and multiple different supported outbound protocols.

### [✨ Features](https://github.com/Watfaq/clash-rs#-features) <a href="#user-content--features" id="user-content--features"></a>

* 🌈 Flexible traffic routing rules based off source/destination IP/Domain/GeoIP/GeoSite/Process etc.
* 📦 Local anti-spoofing DNS with support of UDP/TCP/DoH/DoT remote, exposed as a local UDP/TCP/DoH/DoT server.
* 🛡 Multiple inbound modes: HTTP, SOCKS5, Mixed, Shadowsocks, Redir, TProxy, and TUN (utun) for transparent proxying.
* ⚙️ AnyTLS/Hysteria2/ShadowQuic/Shadowsocks/Socks5/SSH/Tailscale/Tor/Trojan/Tuic/VLess/VMess/WireGuard outbound support with transports including gRPC, TLS, H2, and WebSocket.
* 🌍 Dynamic remote rule/proxy loader.
* 🎵 Tracing with Jaeger (build with `--features telemetry`)

## Links

* Repository - <https://github.com/Watfaq/clash-rs>
* Download - <https://github.com/Watfaq/clash-rs/releases>

## Get Started

We've put together some helpful guides for you to get setup with our product quickly and easily.

{% content-ref url="/pages/gLcnRlT3YqHPBMfgbClz" %}
[Getting set up](/clashrs-user-manual/using-it/getting-set-up.md)
{% endcontent-ref %}

{% content-ref url="/pages/mOYOaKurvPPCWUNJvjyw" %}
[Configuration](/clashrs-user-manual/using-it/configuration.md)
{% endcontent-ref %}

{% content-ref url="/pages/LPcrlYLb39p17asguu64" %}
[Config References](/clashrs-user-manual/using-it/config-references.md)
{% endcontent-ref %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://watfaq.gitbook.io/clashrs-user-manual/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.