Getting Started

xrat is a Rust-based CLI tool and daemon for managing proxy configurations. It imports subscription links, parses and normalizes proxy URIs, tests connectivity and performance, previews runtime configs for Xray-core and sing-box, manages an Xray/V2Ray local proxy runtime process, and exposes an HTTP API.

Prerequisites

• Xray-core binary installed and available in PATH
• sing-box binary (optional, used for sing-box parse/preview support)
• Rust toolchain and just when building from source

Installation

Choose one install path:

• Installation Script — recommended Linux install from the latest verified release archive
• Docker Install — run the published container image with bundled Xray-core
• Manual Binary Install — download, verify, and place release files yourself
• Build From Source — Justfile-oriented workflow for local development builds and source installs

Configuration Directory

xrat uses a configuration directory with the following resolution order:

1. --config <path> CLI flag
2. XRAT_PATH environment variable
3. ~/.config/xrat/

The directory layout:

~/.config/xrat/
├── config.toml      # Application configuration
├── db.sqlite        # SQLite database (default)
├── runtime/         # Runtime session files (generated configs, logs)
└── logs/            # Xray/V2Ray process logs

Next Steps

• Quickstart — import, test, and connect in 3 commands
• Installation Script — recommended install path
• Configuration — config.toml reference