Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

xrat — proxy manager for Xray-core and sing-box

xrat 🐀

xrat is a command-line proxy configuration manager for Xray-core and sing-box. Import subscriptions, test latency, scan edge IPs, rotate proxies, and run a managed Xray/V2Ray proxy runtime — all from a single Rust binary.

What you can do

  • Import proxy configs from subscription URLs, base64 files, or raw VLESS/VMESS/Trojan/Shadowsocks links
  • Test proxies with real-delay, TCP ping, ICMP, download/upload speed measurements
  • Scan Cloudflare edge IPs and persist working endpoints
  • Run Xray-core or V2Ray as a managed runtime with automatic proxy rotation
  • Control everything through CLI, terminal UI (TUI), HTTP API, or background daemon

sing-box support currently covers parsing and runtime-config preview, including Hysteria2 diagnostics through xrat parse --engine sing-box. Managed runtime process lifecycle is Xray/V2Ray-focused.

Sections

SectionDescription
Getting StartedInstallation, quickstart, configuration
CLI ReferenceCommand reference for all subcommands
FeaturesDeep-dives into each major subsystem
Deploymentsystemd services, database backends
ReferenceProtocols, config file, database schema, errors
ArchitectureModule map, config generation pipeline