What is warp-clash-api?

Cloudflare WARP is a free internet service that routes your traffic through Cloudflare's network, and the paid WARP+ tier provides access to faster nodes. WARP-Clash-API is a self-hosted tool that lets you use WARP+ through popular VPN client apps like Clash, Surge, and Shadowrocket by generating a subscription link those apps can read. The README is primarily in Chinese, though the project description includes an English summary. The tool runs as a small server on your own machine or a remote server. Once running, it produces a subscription URL that you paste into a VPN client app. That app then connects using the WARP+ configuration the server provides. One of the tool's features is automatically refreshing WARP+ traffic allowance by periodically calling Cloudflare's systems, which the README says can add 1 GB of traffic every 18 seconds. Another feature is IP selection: since WARP uses many different server addresses, the tool tests them for speed and packet loss and filters out slow or unreliable ones. You can also run the IP selection process manually at any time. The configuration is done through environment variables in a file you create locally. Options include how often to refresh traffic, what delay threshold to use when filtering server addresses, whether to protect the subscription URL with a secret key, and whether to share the subscription publicly. Deployment is done via Docker Compose, which means you start the whole service with a single command. An optional configuration file handles any settings you want to change from the defaults. The README notes this is a non-commercial project intended for learning and exchange, not for illegal use. The project builds on several other open-source tools for proxy pooling and WireGuard configuration, which are credited in the README.