Brush
🐚bash/POSIX-compatible shell implemented in Rust 🦀
Install / Use
/learn @reubeno/BrushREADME
brush (Bo(u)rn(e) RUsty SHell) is a modern bash- and POSIX- 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.<br/>
✨ Syntax highlighting and auto-suggestions built in and enabled by default.<br/>
🧪 Validated against bash with ~1500 compatibility tests.<br/>
🧩 Easily embeddable in your Rust apps using brush_core::Shell.<br/>
⚠️ Not everything works yet:
coproc,select, and some edge cases aren't supported. See the Compatibility Reference for details.
Quick start:
$ 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 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) |
| ✅ | Auto-suggestions | History-based hints as you type (reedline) |
| ✅ | Rich prompts | PS1/PROMPT_COMMAND, right prompts, starship 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.
Homebrew users can install using the brush formula:
brew install brush
Arch Linux users can install brush from the official extra repository:
pacman -S brush
You may use cargo binstall to install pre-built brush binaries. Once you've installed cargo-binstall you can run:
cargo binstall brush-shell
We publish prebuilt binaries of brush for Linux (x86_64, aarch64) and macOS (aarch64) to GitHub for official releases. 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.:
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, e.g.:
gh attestation verify brush-x86_64-unknown-linux-gnu.tar.gz --repo reubeno/brush
If you are a Nix user, you can use the registered version:
nix run 'github:NixOS/nixpkgs/nixpkgs-unstable#brush' -- --version
To build from sources, first install a working (and recent) rust toolchain; we recommend installing it via rustup. Then run:
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!
- Discord server — chat with the community
- Building from source — development workflow
- Contribution guidelines — how to submit changes
- Technical docs — architecture and reference
Related Projects
Other POSIX-ish shells implemented in non-C/C++ languages:
nushell— modern Rust shell (providesreedline)fish— user-friendly shell (Rust port in 4.0)Oils— bash-compatible with new Oil languagemvdan/sh— Go implementationrusty_bash— another Rust bash-like shell
This project relies on many excellent OSS crates:
reedline— readline-like input and interactive featuresclap— command-line parsingfancy-regex— regex supporttokio— async runtimenix— Unix/POSIX APIscriterion.rs— benchmarkingbash-completion— completion test suite
Licensed under the MIT license.
