Overview

These pages cover the brush shell: installing it, running it, and configuring it. brush runs your existing Bash scripts and startup files as your everyday shell, and also ships as a Rust crate you can embed and extend in your own software; the crate’s API is documented on docs.rs.

Start here

Install brushGet the brush shell onto your machine.

First stepsRun brush for the first time, turn on syntax highlighting, and give it a startup file of its own.

Going further

Configure brushWhich of .bashrc, .brushrc and config.toml a setting belongs in, and which files brush reads when.

Set up bash-completionExtended completions for common commands.

Terminal shell integrationPrompt and command markers for terminals that support them.

ReferenceBash compatibility, command-line options, the configuration file, and experimental features, for the current release.

Release notesWhat changed in each release.

CommunityWhere to ask questions, report bugs, and get involved.