Skip to main content

Module cli

Module cli 

Source
Expand description

The command line: which command to run, with its options.

  • [entries]: commands that read or change entries by id, for agents and scripts.
  • [mod@init]: a project’s .brain/, and the section telling its agents about it; deinit undoes it.
  • [claude]: the Claude Code hooks init adds: the context at each session start, and [hook]’s checks.
  • [hook]: kb hook prompt|stop, which hold an agent to describing an undescribed project first, and to commenting on the task it started.
  • [completions]: kb completions SHELL, tab completion, and the ids, projects and tags it offers.
  • [update]: kb update, the latest release over this one, through the installer.

Structs§

AddArgs
Options of add.
EntryArgs
One of the entry commands, and whether to print JSON.
ListArgs
Options of kb list.
Program
The binary running the command line, named in the usage text and --version.
ReportArgs
Options of kb report.

Enums§

Command
What to do, as chosen on the command line.
EntryCommand
What to do to which entry.
ProjectPart
What project changes.
Text
Text given on the command line, or - to read it from stdin (for multi-line markdown).

Functions§

init
Makes root a repository of project name (else the one its card names, else one named after the folder): creates its .brain/ and card, registers it in central (joining the project’s other repositories if it has some), creates the project’s shared card if it’s new, and writes or refreshes the section in each agent file of root (creating CLAUDE.md if there’s none). Returns what it did, one line each.
usage
Printed by --help and after a command-line error. The status, period and group names come from Status, Unit and Group, so they’re only written there.