Installation
Relux is distributed as a single binary with no runtime dependencies.
Prerequisites
cargo install and building from source require a working Rust toolchain. The recommended way to install it is through rustup:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
Relux uses Rust edition 2024, which requires Rust 1.85 or later. If you already have Rust installed, make sure you are on a recent stable version:
rustup update stable
Install from crates.io
The simplest way to install Relux is via Cargo:
cargo install relux
This downloads, compiles, and installs the relux binary into ~/.cargo/bin/.
Pre-built binaries
Pre-built binaries for Linux (x86_64) and macOS (aarch64) are available on the Releases page. No Rust toolchain required.
Building from source
If you prefer to build from source:
git clone https://github.com/shizzard/relux.git
cd relux
cargo build --release
The binary will be at target/release/relux. You can copy it somewhere on your PATH, or run it directly from the build directory.
If you have just installed, you can also build with:
just release
Verifying the installation
Run relux without arguments to confirm the binary works:
relux
You should see the help output listing the available subcommands.
Shell completions
Relux supports tab completions for bash, zsh, and fish. To install them:
relux completions --install
This autodetects your shell and writes the completion script to the standard location. For zsh, you need to specify a path:
relux completions --shell zsh --install --path ~/.zsh/completions
See The CLI for details.
Next: Getting Started — scaffold a project, write and run your first test