brush

Project Overview

brush (Born 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.

Key Features

• bash Compatibility: 50+ builtins, full expansions, control flow, redirection, arrays & variables, programmable completion, job control
• User Experience: Real-time syntax highlighting, history-based auto-suggestions, rich prompts (PS1/PROMPT_COMMAND), TOML config, fzf/atuin support, VS Code terminal integration
• Embeddable: Easily embeddable in Rust apps using brush_core::Shell
• Validated against bash with ~1700 compatibility tests

Target Audience

• Developers who want to try a modern Rust shell
• Users who need a bash-compatible shell
• Developers interested in Rust shell implementations

Quick Start

# Using cargo-binstall
cargo binstall brush-shell
# Using Homebrew
brew install brush
# Arch Linux
pacman -S brush
# Build from source
cargo install --locked brush-shell

Core Advantages

• Written in Rust for excellent performance
• Highly compatible with bash, works with existing configurations
• Built-in syntax highlighting and auto-suggestions
• Embeddable in Rust applications

System Requirements

• OS: Cross-platform
• Additional Dependencies: Rust (for source builds)