brb-cli 1.0.1

Tired of babysitting commands for hours? Brb will notify you when that commands done.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

<p align="center">
  <img src="assets/readme/demo.gif" alt="brb demo" />
</p>

# `brb`

Tired of babysitting commands for hours? `brb` is a wrapper for commands, it
waits for a given command to complete, then sends a completion event to your
configured channels.

Best used for long builds, test suites, data jobs, and deploy commands.

## Setup

Install from cargo:

```bash
cargo install brb-cli
```

Then setup like so:

```bash
# create global config
brb init

# check where config is stored
brb config path

# run something and notify default channels
brb cargo test

# override channels for one run
brb --channel phone pnpm test
```

## Usage

```plaintext
brb [--channel <channel-id> ...] <command> [args...]
brb init
brb channels list
brb channels validate
brb channels test <channel-id>
brb config
brb config path
brb --help
brb --version
```

If your wrapped command begins with flags, separate with `--`:

```bash
brb --channel desktop -- --version
```

## Cookbook

| Goal                      | Command                                               |
|---------------------------|-------------------------------------------------------|
| Run with defaults         | `brb cargo test`                                      |
| Use one specific channel  | `brb --channel desktop cargo test`                    |
| Use multiple channels     | `brb --channel mobile --channel ci-webhook pnpm test` |
| Validate config           | `brb channels validate`                               |
| Send test notification    | `brb channels test desktop`                           |
| Print config path         | `brb config path`                                     |

## Config

A fully commented example is included at `assets/examples/config.yml`.

### Channel Types

| Type       | Purpose                           | Required Fields | Optional Fields                         |
|------------|-----------------------------------|-----------------|-----------------------------------------|
| `desktop`  | Local desktop notification        | `type`          | none                                    |
| `webhook`  | HTTP JSON event delivery          | `type`, `url`   | `method` (default `POST`), `headers`    |
| `custom`   | Execute your own notifier process | `type`, `exec`  | `args`, `env`                           |

### Custom

`custom` channels are an executable that receive one JSON event on stdin.

`exec` supports:

- Relative path: resolved from the working directory where `brb` is launched.
- Absolute path: used directly.

The JSON the executable will receive is shaped like so:

```json
{
  "tool": "brb",
  "status": "success",
  "command": ["pnpm", "test"],
  "cwd": "/path/to/project",
  "started_at": "2026-02-22T12:00:00.000Z",
  "finished_at": "2026-02-22T12:00:03.250Z",
  "duration_ms": 3250,
  "exit_code": 0,
  "host": "my-machine"
}
```