Commands: Upkeep

These commands keep the record sound: check it, write its files in canonical form, and rb’s own settings and optional usage analytics.

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

rb doctor

check the record: who you are recorded as, edits made outside rb, merge leftovers, sources outside the repository

usage: rb doctor [-h] [--json] [--restore] [--adopt] [-m WHY] [--words TEXT]
                 [--seen PATH@SHA256]

options:
  -h, --help          show this help message and exit
  --json              print one JSON object (the envelope) instead of text
  --restore           put back what rb last wrote for every record changed
                      outside rb
  --adopt             take every change made outside rb as it stands (with
                      --why); edits to who wrote or decided what are refused
  -m WHY, --why WHY   the reason, recorded with --adopt
  --words TEXT        the user's words from the chat that this acts on,
                      verbatim (an agent quoting them); kept beside the reason
  --seen PATH@SHA256  with --adopt: the reviewed files, each pinned to the sha
                      it had (or 'deleted'); any drift since is refused

rb fmt

write Rabbit Brain YAML files in their canonical form, comments kept (default: every record file under .rb/)

usage: rb fmt [-h] [--json] [--check] [paths ...]

positional arguments:
  paths       files or directories (default: the record)

options:
  -h, --help  show this help message and exit
  --json      print one JSON object (the envelope) instead of text
  --check     change nothing; exit 1 if any file is not canonical

rb telemetry

optional usage analytics: off until you enable it; never sends research content

usage: rb telemetry [-h] <status|enable|disable|preview|flush> ...

positional arguments:
  <status|enable|disable|preview|flush>
    status              show the local analytics setting and destination
                        without sending anything
    enable              opt in to limited usage analytics on this installation
    disable             stop analytics and delete the local installation ID
                        and pending events
    preview             show the queued payload without sending it
    flush               try sending the pending usage events now

options:
  -h, --help            show this help message and exit

rb telemetry status

usage: rb telemetry status [-h] [--json]

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

rb telemetry enable

usage: rb telemetry enable [-h] [--json] [--project-key PROJECT_KEY]
                           [--host HOST]

options:
  -h, --help            show this help message and exit
  --json                print one JSON object (the envelope) instead of text
  --project-key PROJECT_KEY
                        PostHog public project capture key; never a personal
                        API key
  --host HOST           PostHog HTTPS ingestion host (must match the project's
                        region)

rb telemetry disable

usage: rb telemetry disable [-h] [--json]

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

rb telemetry preview

usage: rb telemetry preview [-h] [--json]

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

rb telemetry flush

usage: rb telemetry flush [-h] [--json]

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

rb config

rb’s own settings on this machine: whether rb keeps itself up to date

usage: rb config [-h] [--json] <auto-update> ...

positional arguments:
  <auto-update>
    auto-update  whether rb checks for a newer rb once a day, and updates
                 itself when it was installed as a tool (uv tool install,
                 pipx); says the setting with no value

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

rb config auto-update

usage: rb config auto-update [-h] [--json] [{on,off}]

Whether rb checks PyPI for a newer rb at most once a day: installed as a tool
(uv tool install, pipx) it updates itself in the background, and installed
with pip it says one line and changes nothing. Never in CI, in an agent
session or under DO_NOT_TRACK. With no value it says the setting.

positional arguments:
  {on,off}    on or off

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