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

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 architecture:

FileArchitecture
xrat-vX.Y.Z-x86_64-unknown-linux-musl.tar.gzx86_64 (most PCs)
xrat-vX.Y.Z-aarch64-unknown-linux-musl.tar.gzARM64 (Pi 4/5, Graviton)

Download SHASUMS256.txt from the same release.

Verify

Run the checksum verification from the directory containing the archive and SHASUMS256.txt:

sha256sum -c SHASUMS256.txt --ignore-missing

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.

Install Shell Completions

The release archive includes generated completion files.

Bash

mkdir -p ~/.local/share/bash-completion/completions
cp completions/xrat.bash ~/.local/share/bash-completion/completions/xrat

Reload by opening a new shell or sourcing your Bash startup file.

Zsh

mkdir -p ~/.zfunc
cp completions/_xrat ~/.zfunc/_xrat

Add this to ~/.zshrc if ~/.zfunc is not already in fpath:

fpath=("$HOME/.zfunc" $fpath)
autoload -Uz compinit
compinit

Fish

mkdir -p ~/.config/fish/completions
cp completions/xrat.fish ~/.config/fish/completions/xrat.fish

Install Man Pages

mkdir -p ~/.local/share/man/man1
cp man/man1/*.1 ~/.local/share/man/man1/
mandb ~/.local/share/man

If mandb is unavailable, the man pages are still copied; your system may index them later.

Install Desktop Entry

mkdir -p ~/.local/share/applications
mkdir -p ~/.local/share/icons/hicolor/48x48/apps
mkdir -p ~/.local/share/icons/hicolor/256x256/apps
cp desktop/xrat.desktop ~/.local/share/applications/
cp desktop/icons/xrat-48x48.png ~/.local/share/icons/hicolor/48x48/apps/xrat.png
cp desktop/icons/xrat-256x256.png ~/.local/share/icons/hicolor/256x256/apps/xrat.png
update-desktop-database ~/.local/share/applications/

First-Time Setup

xrat init
xrat daemon install --start

Then follow the Quickstart.