brush

---

`brush` (**B**o(u)rn(e) **RU**sty **SH**ell) is a modern [bash-](https://www.gnu.org/software/bash/) and [POSIX-](https://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html) compatible shell written in Rust. Run your existing scripts and `.bashrc` unchanged -- with syntax highlighting and auto-suggestions built in. ## At a glance ✅ Your existing `.bashrc` just works—aliases, functions, completions, all of it.
✨ Syntax highlighting and auto-suggestions built in.
Validated against bash with [~1700 compatibility tests](brush-shell/tests/cases).
Easily embeddable in your Rust apps using `brush_core::Shell`.

> ⚠️ **Not everything works yet:** `select` and some edge cases aren't supported. See the [Compatibility Reference](docs/reference/compatibility.md) for details. ### Quick start: ```console $ curl --proto '=https' --tlsv1.2 -fsSL https://raw.githubusercontent.com/reubeno/brush/main/scripts/install/install.sh | sh $ cargo binstall brush-shell # using cargo-binstall $ brew install brush # using Homebrew $ pacman -S brush # Arch Linux $ cargo install --locked brush-shell # Build from sources ``` `brush` is ready for use as a daily driver. We test every change against `bash` to keep it that way. More detailed installation instructions are available below. ## ✨ Features ### `bash` Compatibility | | Feature | Description | |--|---------|-------------| | ✅ | **50+ builtins** | `echo`, `declare`, `read`, `complete`, `trap`, `ulimit`, ... | | ✅ | **Full expansions** | brace, parameter, arithmetic, command/process substitution, globs, `extglob`, `globstar` | | ✅ | **Control flow** | `if`/`for`/`while`/`until`/`case`, `&&`/`\|\|`, subshells, pipelines, etc. | | ✅ | **Redirection** | here docs, here strings, fd duplication, process substitution redirects | | ✅ | **Arrays & variables** | indexed/associative arrays, dynamic variables, standard well-known variables, etc. | | ✅ | **Programmable completion** | Works with [bash-completion](https://github.com/scop/bash-completion) out of the box | | ✅ | **Job control** | background jobs, suspend/resume, `fg`/`bg`/`jobs` | | | **Traps & options** | `DEBUG`/`ERR`/`EXIT` traps work; signal traps and options in progress | ### ⌨️ User Experience | | Feature | Description | |--|---------|-------------| | ✅ | **Syntax highlighting** | Real-time as you type ([reedline](https://github.com/nushell/reedline)) | | ✅ | **Auto-suggestions** | History-based hints as you type ([reedline](https://github.com/nushell/reedline)) | | ✅ | **Rich prompts** | `PS1`/`PROMPT_COMMAND`, right prompts, [starship](https://starship.rs) compatible | | ✅ | **TOML config** | `~/.config/brush/config.toml` for persistent settings | | | **Extras** | `fzf`/`atuin` support, zsh-style `precmd`/`preexec` hooks (experimental), VS Code terminal integration | ## Installation _When you run `brush`, it should look exactly as `bash` does on your system: it processes your `.bashrc` and other standard configuration. If you'd like to distinguish the look of `brush` from the other shells on your system, you may author a `~/.brushrc` file._ Installing using Homebrew (macOS/Linux) Homebrew users can install using [the `brush` formula](https://formulae.brew.sh/formula/brush): ```bash brew install brush ``` Installing on Arch Linux Arch Linux users can install `brush` from the official [extra repository](https://archlinux.org/packages/extra/x86_64/brush/): ```bash pacman -S brush ``` Installing on MSYS2 MSYS2 users can install `brush` from the [repository](https://packages.msys2.org/base/mingw-w64-brush): ```bash pacman -S mingw-w64-ucrt-x86_64-brush # or mingw-w64-clang-x86_64-brush or mingw-w64-clang-aarch64-brush ``` Installing prebuilt binaries via `cargo binstall` You may use [cargo binstall](https://github.com/cargo-bins/cargo-binstall) to install pre-built `brush` binaries. Once you've installed `cargo-binstall` you can run: ```bash cargo binstall brush-shell ``` Installing prebuilt binaries from GitHub We publish prebuilt binaries of `brush` for Linux (x86_64, aarch64) and macOS (x86_64, aarch64) to GitHub for official [releases](https://github.com/reubeno/brush/releases). The simplest way to install one is with our install script, which installs `brush` to `~/.local/bin`: ```bash curl --proto '=https' --tlsv1.2 -fsSL https://raw.githubusercontent.com/reubeno/brush/main/scripts/install/install.sh | sh ``` The script checks the download against its published SHA-256 checksum, which guards against a corrupted download but not a compromised release (the checksum comes from the same release). If an authenticated [GitHub CLI](https://cli.github.com/) is available, it also verifies the archive's build provenance attestation, confirming it was built by this repository's release workflow; pass `--require-attestation` to fail rather than proceed when that check can't be performed. See the comments at the top of [`scripts/install/install.sh`](scripts/install/install.sh) for all options. Alternatively, you can manually download and extract the `brush` binary from one of the archives published there, or otherwise use the GitHub CLI to download it, e.g.: ```bash gh release download --repo reubeno/brush --pattern "brush-x86_64-unknown-linux-gnu.*" ``` After downloading the archive for your platform, you may verify its authenticity using the [GitHub CLI](https://cli.github.com/), e.g.: ```bash gh attestation verify brush-x86_64-unknown-linux-gnu.tar.gz --repo reubeno/brush ``` Installing using Nix If you are a Nix user, you can use the registered version: ```bash nix run 'github:NixOS/nixpkgs/nixpkgs-unstable#brush' -- --version ``` Installing on Fedora (community package) `brush` isn't packaged in Fedora's official repositories, but a community-maintained `brush-shell` package is available from [Terra](https://terrapkg.com/), a separately maintained, third-party repository for Fedora and its derivatives. Once you've enabled the Terra repository: ```bash dnf install brush-shell ``` Building from sources To build from sources, first install a working (and recent) `rust` toolchain; we recommend installing it via [`rustup`](https://rustup.rs/). Then run: ```bash cargo install --locked brush-shell ``` ## Community & Contributing This project started out of curiosity and a desire to learn—we're keeping that attitude. If something doesn't work the way you'd expect, [let us know](https://github.com/reubeno/brush/issues)! * [Discord server](https://discord.gg/kPRgC9j3Tj) — chat with the community * [Building from source](docs/how-to/build.md) — development workflow * [Contribution guidelines](CONTRIBUTING.md) — how to submit changes * [Technical docs](docs/README.md) — architecture and reference ## Related Projects Other POSIX-ish shells implemented in non-C/C++ languages: * [`nushell`](https://www.nushell.sh/) — modern Rust shell (provides `reedline`) * [`fish`](https://fishshell.com) — user-friendly shell ([Rust port in 4.0](https://fishshell.com/blog/rustport/)) * [`Oils`](https://github.com/oils-for-unix/oils) — bash-compatible with new Oil language * [`mvdan/sh`](https://github.com/mvdan/sh) — Go implementation * [`rusty_bash`](https://github.com/shellgei/rusty_bash) — another Rust bash-like shell Credits This project relies on many excellent OSS crates: * [`reedline`](https://github.com/nushell/reedline) — readline-like input and interactive features * [`clap`](https://github.com/clap-rs/clap) — command-line parsing * [`fancy-regex`](https://github.com/fancy-regex/fancy-regex) — regex support * [`tokio`](https://github.com/tokio-rs/tokio) — async runtime * [`nix`](https://github.com/nix-rust/nix) — Unix/POSIX APIs * [`criterion.rs`](https://github.com/bheisler/criterion.rs) — benchmarking * [`bash-completion`](https://github.com/scop/bash-completion) — completion test suite --- Licensed under the [MIT license](LICENSE).