Install brush

brush is packaged for several platforms. Pick whichever fits your system.

Install script

Installs the latest release binary for Linux or macOS into ~/.local/bin (or $XDG_BIN_HOME), and verifies its SHA-256 checksum. If the GitHub CLI is installed and signed in, it also verifies the build’s provenance attestation:

curl --proto '=https' --tlsv1.2 -fsSL https://brush.sh/install.sh | sh

To pick a version or install directory, pass options after sh -s --:

curl --proto '=https' --tlsv1.2 -fsSL https://brush.sh/install.sh | sh -s -- --version 0.4.0 --dir ~/bin

Add --require-attestation to fail, rather than continue, when the attestation can’t be checked.

Homebrew

Available for macOS and Linux via the brush formula:

brew install brush

Arch Linux

Available in the official extra repository:

sudo pacman -S brush

Fedora

brush isn’t in Fedora’s official repositories, but a community-maintained package is available from Terra, a third-party repository for Fedora and its derivatives. Once Terra is enabled:

sudo dnf install brush-shell

Note

This package is maintained by the Terra project rather than by brush.

Windows (MSYS2)

MSYS2 users can install from the mingw-w64-brush package:

pacman -S mingw-w64-ucrt-x86_64-brush

Clang variants are also published as mingw-w64-clang-x86_64-brush and mingw-w64-clang-aarch64-brush.

Outside MSYS2, install with cargo install or cargo binstall — see those tabs. There is no winget or scoop package yet, and the prebuilt binaries attached to GitHub releases do not (yet) include Windows targets. That’s planned for an upcoming release.

Nix

Run it without installing:

nix run 'github:NixOS/nixpkgs/nixpkgs-unstable#brush' -- --version

To install permanently, add brush to your environment.systemPackages or your home-manager configuration.

cargo-binstall

If you have cargo-binstall, you can fetch a prebuilt binary without compiling:

cargo binstall brush-shell

Build from source

1. Install a recent Rust toolchain. We recommend rustup:

   curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

2. Build and install brush:

   cargo install --locked brush-shell

3. Make sure ~/.cargo/bin is on your PATH. If you used rustup, add this to your shell’s rc file (for example ~/.bashrc):

   . "$HOME/.cargo/env"

GitHub Releases

Prebuilt binaries are published for Linux (x86_64, aarch64 — both gnu and musl) and macOS (x86_64, aarch64). Windows binaries are not (yet) published, but that’s planned for an upcoming release; you can cargo install or use an MSYS2 build instead for the meantime.

1. Download the archive for your platform from the latest release, or use the GitHub CLI:

   gh release download --repo reubeno/brush \
     --pattern "brush-x86_64-unknown-linux-gnu.tar.gz"

2. Optionally verify the archive’s provenance:

   gh attestation verify brush-x86_64-unknown-linux-gnu.tar.gz --repo reubeno/brush

3. Extract it and put the binary somewhere on your PATH:

   tar xzf brush-x86_64-unknown-linux-gnu.tar.gz
   sudo mv brush /usr/local/bin/

Tip

Each archive also has published .sha256 and .sha512 checksums if you’d rather verify that way.

Check that it worked

brush --version

If you get brush: command not found, the install directory isn’t on your PATH — ~/.local/bin for the install script, ~/.cargo/bin for cargo.

Next steps

Head to First steps to run brush for the first time.