Quick Start

Install the Tool

Before you begin, make sure you have cargo installed. If you don't already have it, follow the official installation guide here.

Then install brb:

cargo install brb-cli

Confirm the CLI is available:

brb --version

Create Your Config

Initialise the global config file:

brb init

This command only creates the file if it does not already exist, so it is safe to run multiple times. To see where your config file is stored:

brb config path

For the quickest possible setup, start with a simple desktop-only config:

version: 1
default_channels:
  - desktop
channels:
  desktop:
    type: desktop

Validate And Test Your Setup

After editing your config, validate it:

brb channels validate

To test a specific channel without running a real command:

brb channels test desktop

This sends a fake success notification so you can confirm everything is working.

Run Your First Command

brb cargo test # `cargo test` can be whatever command you want.

cargo test is just an example - you can replace it with any command.

If you do not provide any --channel flags, Be Right Back uses the channel IDs listed in default_channels.

When the command finishes, Be Right Back sends a completion event to each selected channel and exits with the same status code as the wrapped command.

That's it! 🎉

Now you are ready to use brb. Head to Configuration to learn how to customise channels, defaults, and behaviour.