Skip to content

Commands: Reading it

These commands read the record: in your browser, in your terminal, as one briefing for an agent, or as one page to send.

Generated from the --help of rabbit-brain 0.8.0.

the catalogue in your browser, live and read-only, on 127.0.0.1 only

usage: rb open [-h] [--json] [--port PORT]
options:
-h, --help show this help message and exit
--json print one JSON object (the envelope) instead of text
--port PORT port on 127.0.0.1 (default 8787)

open this project in your terminal: your call, the cards, the tree (bare rb does this too)

usage: rb ui [-h] [--json]
options:
-h, --help show this help message and exit
--json print one JSON object (the envelope) instead of text

each criterion on its axes, and what is open, with who usually acts

usage: rb status [-h] [--json] [--fail-on GATE] [experiment]
positional arguments:
experiment only this experiment
options:
-h, --help show this help message and exit
--json print one JSON object (the envelope) instead of text
--fail-on GATE exit 1 when any of: unmet, unresolved, untested, integrity,
undecided, stale, unknown, late, checks, unestablished
(repeatable or comma-separated); an edit made outside rb
that a finding depends on fails any of them

one record: a criterion with its finding, an experiment with its spec, a run with its receipt, e1/lr with its history; or a .yaml record file as canonical JSON

usage: rb show [-h] [--json] id
positional arguments:
id an id, <experiment>/<setting>, or a path to an Rabbit Brain YAML
file
options:
-h, --help show this help message and exit
--json print one JSON object (the envelope) instead of text

an experiment’s own table: variants by metrics, with changes against the baseline

usage: rb compare [-h] [--json] [experiment]
positional arguments:
experiment
options:
-h, --help show this help message and exit
--json print one JSON object (the envelope) instead of text

every write, newest last: who, how, what

usage: rb log [-h] [--json] [-n N] [id]
positional arguments:
id only this record, or <experiment>/<setting>
options:
-h, --help show this help message and exit
--json print one JSON object (the envelope) instead of text
-n N how many (default 20)

the record as one Markdown briefing a fresh agent session reads first

usage: rb context [-h] [--json] [--model ID] [--provider NAME]
options:
-h, --help show this help message and exit
--json print one JSON object (the envelope) instead of text
--model ID an agent's own model, as its provider names it: kept with
every later write in this agent session (RB_MODEL gives it
for one command)
--provider NAME who provides that model, kept the same way (RB_PROVIDER for
one command); rb fills in Claude Code's and Codex's when
none is given

write the project as one self-contained, read-only HTML file you can send anywhere

usage: rb page [-h] [--json] [--out OUT] [--replace]
options:
-h, --help show this help message and exit
--json print one JSON object (the envelope) instead of text
--out OUT where to write it (default rb-page.html beside .rb/)
--replace write over a file at --out that rb did not write (default:
refused, the file left as it is)

Rabbit Brainrabbitbrain.ai · GitHub · PyPI · Privacy · Apache-2.0