Scope

This is the compact command map verified against the current stable release. It helps an agent or integrator find the owning command without copying the entire generated manual into documentation.

Run superbee --help for the exact current command list and superbee <command> --help for one command's complete syntax. Generated help from the installed package is authoritative for flags and defaults.

Invocation and bundle selection

Persistent host integrations use the globally installed command:

npm install -g superbee
superbee setup

For bundle commands, selection follows this order:

1. explicit --remote <url> for HTTP access, mutually exclusive with --dir;

2. explicit local --dir <path>;

3. a supported project-local binding;

4. conventional local discovery up the directory tree.

Catalog labels are resolved explicitly and never act as ambient project selection.

Command map

High-value lookups

Orient to the selected workspace

superbee home

home summarizes the CLI identity, selected bundle, recent documents, installed Kinds, grounded capability offers, and relevant integration or release notices.

Verify selection and health

superbee bundle locate
superbee status

Use bundle locate when the selected path is surprising. status reports malformed documents, Kind warnings, unresolved links, orphans, staleness, graph findings, and View-registration health.

Read without flooding model context

superbee list
superbee doc read <id>
superbee doc read <id> --out <file>

List and default reads are bounded. Use --fields on list/query when more columns are required, and use --out, --body-out, or --rendered-out to send complete bytes to a file or trusted consumer while keeping model-facing output bounded.

Create generic or governed documents

superbee doc write <id> --type <type> --title <title>
superbee kinds
superbee new "<Kind>" <id> --help

Use generic doc write for one-off domain concepts. Use new when the bundle already declares a Kind whose fields, headings, and relationships should be enforced.

Present work to a human

superbee doc open <id>
superbee ui --open

doc open targets one specified document. ui presents the selected bundle, cross-links, backlinks, activity, sharing state, and registered Views. Both use the same local UI and renderer.

Share deliberately

superbee sync --establish
superbee sync

init is local. sync --establish is the separate explicit publication decision that creates a shared board through the repository remote. After establishment, ordinary sync commits bundle changes, receives teammates' changes, and pushes without touching code files.

Output contract

• Default structured output is TOON; --json is available for stable machine parsing.

• Errors use structured envelopes and a small exit-code taxonomy.

• Lists report counts and default to compact rows.

• Large document bodies are truncated in model-facing output and name the byte-channel alternative.

• Mutations are idempotent where repeating the same intent is safe.

• --actor or SUPERBEE_ACTOR supplies advisory attribution; a per-command flag wins.

Raw bytes are never mixed with the structured receipt. Commands that reserve stdout for byte or protocol transport route diagnostics separately.

Where command details live

Generated help provides current option tables. Documentation explains which command owns a task, its safety constraints, and a verified journey; the installed package's help owns its complete flags and defaults.