The trellis CLI handles runtime and operator tasks such as service deployments, upgrades, bootstrap, and authentication. Install it before following the operator guides.

Option A: Download a prebuilt binary

Prebuilt binaries are published as GitHub Releases for every tagged version.

Pick the archive that matches your platform:

Platform	Archive
Linux x86_64	trellis-<version>-x86_64-unknown-linux-gnu.tar.gz
Linux aarch64	trellis-<version>-aarch64-unknown-linux-gnu.tar.gz
macOS Intel	trellis-<version>-x86_64-apple-darwin.tar.gz
macOS Apple Silicon	trellis-<version>-aarch64-apple-darwin.tar.gz

Download and extract:

curl -LO https://github.com/qlever-llc/trellis/releases/latest/download/trellis-<version>-<target>.tar.gz
curl -LO https://github.com/qlever-llc/trellis/releases/latest/download/trellis-<version>-<target>.tar.gz.sha256
sha256sum -c trellis-<version>-<target>.tar.gz.sha256
tar xzf trellis-*.tar.gz

Move the binary somewhere on your PATH:

install -m 755 trellis ~/.local/bin/trellis

Each release also includes a .sha256 checksum file. Only extract and install the binary after sha256sum -c reports OK.

Option B: Install with Cargo

If you have a Rust toolchain installed:

cargo install trellis-cli

This builds from source and places the trellis binary in your Cargo bin directory (usually ~/.cargo/bin).

Option C: Build the current checkout

When working against unreleased docs or source, build the CLI from the repository checkout so the available commands match the code you are running:

git clone https://github.com/qlever-llc/trellis.git
cd trellis
cargo xtask prepare
cargo install --path rust/crates/cli

cargo xtask prepare generates the SDK crates that the Rust workspace needs before trellis-cli is built.

Verify

trellis --version