Manual Binary Install

Use this path when you want to inspect or place release files yourself instead of running the installer script.

For the recommended path, see Installation Script. To compile from this repository, see Build From Source.

Download

Go to the latest GitHub release and download the archive for your platform:

Download SHASUMS256.txt from the same release.

Verify

Run the checksum verification from the directory containing the archive and SHASUMS256.txt. On Linux use sha256sum; on macOS use shasum -a 256:

sha256sum -c SHASUMS256.txt --ignore-missing   # Linux
shasum -a 256 -c SHASUMS256.txt --ignore-missing  # macOS

The command should report OK for the archive you downloaded.

Install Binary

tar -xzf xrat-vX.Y.Z-x86_64-unknown-linux-musl.tar.gz
mkdir -p ~/.local/bin
mv xrat ~/.local/bin/xrat
chmod +x ~/.local/bin/xrat

Ensure ~/.local/bin is in PATH:

export PATH="$HOME/.local/bin:$PATH"

Add that line to your shell startup file if needed.

Run Setup

The release archive ships only the binary; man pages, shell completions, and the desktop launcher are generated from the binary itself. Run xrat setup to install everything:

xrat setup

This is idempotent and re-runnable. It checks Xray, sing-box, and V2Ray and can install or update verified user-local copies, runs xrat init, offers to install the background daemon, and installs shell completions, man pages, an xratui shortcut, and (on Linux/XDG) a terminal-aware desktop launcher with icons. Use -y to accept defaults non-interactively, or flags like --no-daemon / --no-desktop to skip individual steps.

To check what is and isn’t configured without changing anything:

xrat setup --check

If you only want individual pieces: xrat init for the config directory and database, xrat daemon install --start for the daemon, or xrat completions <shell> / xrat manpage --output <dir> to print/generate those assets yourself.

Then follow the Quickstart.