dorkhub

brush

🐚bash/POSIX-compatible shell implemented in Rust πŸ¦€

reubeno
Rustβ˜… 2.1kβ‘‚ 112 forksMITupdated 4 days ago
visit the demogit clone https://github.com/reubeno/brush.gitreubeno/brush


1389 compatibility tests Packaging status Discord invite


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.
✨ Syntax highlighting and auto-suggestions built in.
πŸ§ͺ Validated against bash with ~1700 compatibility tests.
🧩 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 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.

🍺 Installing using Homebrew (macOS/Linux)

Homebrew users can install using the brush formula:

brew install brush
Installing on Arch Linux

Arch Linux users can install brush from the official extra repository:

pacman -S brush
icon Installing on MSYS2

MSYS2 users can install brush from the repository:

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 to install pre-built brush binaries. Once you've installed cargo-binstall you can run:

cargo binstall brush-shell
πŸš€ Installing prebuilt binaries from GitHub

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
🐧 Installing using Nix

If you are a Nix user, you can use the registered version:

nix run 'github:NixOS/nixpkgs/nixpkgs-unstable#brush' -- --version
πŸ”¨ Building from sources

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!

Related Projects

Other POSIX-ish shells implemented in non-C/C++ languages:

πŸ™ Credits

This project relies on many excellent OSS crates:


Licensed under the MIT license.

more like this

perplexity-cli

🧠 A simple command-line client for the Perplexity API. Ask questions and receive answers directly from the terminal! πŸš€πŸš€πŸš€

Pythonβ˜… 176

anne-key

Firmware for Anne Pro Keyboard written in Rust

Rustβ˜… 572

TachiSnap

TachiSnap β€” Pixel Snapper for animation pixel artists. Rust + WebAssembly client-side tool for cleaning up AI-generated…

HTMLβ˜… 50

bit_gossip

Pathfinding library for calculating all node pairs' shortest paths in an unweighted undirected graph.

Rustβ˜… 50

search

search projects, people, and tags