SuperbeeDocs
v0.1.4Source repository

Reference

CLI commands

Generated current command inventory plus stable invocation and output conventions.

Last updated

View Markdown

Scope

This reference is a searchable inventory of the public command graph in the current stable Superbee CLI. Use superbee <command> --help for every option, default, safety precondition, and example attached to one command.

The inventory is generated from executable help and checked for drift. It is verified against the current stable release.

Invocation and selection

superbee <command> [options]
superbee <command> --help

For local operations, --dir <path> selects a bundle explicitly. --remote <url> selects the HTTP backend explicitly and is mutually exclusive with --dir. Without either, local selection follows the resolution order documented in Configuration and bundle resolution.

Generated command inventory

The text between the markers is owned by npm run cli-reference:build. Do not edit it by hand.

<!-- BEGIN GENERATED CLI INVENTORY -->

Generated from the current stable package's executable help. 34 command entries are present.

GroupCommand signature
Bundlebundle locate [--dir <path>]
Bundlecatalog (add <label> [--dir <path>] | list | resolve <label-or-id> [--field path])
Bundleinit [--dir <path>] [--okf-version <v>] [--recipe <name-or-path>] [--create-only]
Bundleindex generate [--dir <path>] [--check] [--force] [--actor <name>]
Bundlestatus [--limit <n>] [--dir <path>] [--remote <url>]
Documents & linksdoc write <id> --type <t> [--title <t>] [--body <s> | --body-file <p>] [--actor <n>] [--dir <path>] [--remote <url>]
Documents & linksdoc update <id> [--<field> <value> ...] [--title <t>] [--tag <t>] [--type <t>] [--body <s> | --body-file <p>] [--expected-version <v>] [--actor <n>] [--dir <path>] [--remote <url>]
Documents & linksdoc read <id> [--out (<path> | -) | --body-out (<path> | -) | --rendered-out (<path> | -) | --field <name>] [--dir <path>] [--remote <url>]
Documents & linksdoc open <id> [--dir <path> | --remote <url>] [--port <n>] [--actor <name>]
Documents & linksdoc history <id> [--limit <n>] [--dir <path>] [--remote <url>]
Documents & linksdoc delete <id> [--expected-version <v>] [--dir <path>] [--remote <url>]
Documents & linkslist [--type <t>] [--tag <t>] [--field <k=v>] [--prefix <p>] [--open] [--limit <n>] [--dir <path>] [--remote <url>]
Documents & linkslink (add <from> <to> [--text <t>] [--actor <n>] | show <id> [--limit <n>] [--text <t>] | list [--from <id|prefix/>] [--to <id|prefix/>] [--text <t>] [--limit <n>]) [--dir <path>] [--remote <url>]
Artifactsartifact create <file> --title <title> [--description <text>] [--supersedes <id>] [--actor <n>] [--dir <path>] [--remote <url>]
Artifactspromote <file> --doc-key <key> [--content-type <mime>] [--expected-version <v>] [--dir <path>] [--remote <url>]
Artifactspull --doc-key <key> --out (<path> | -) [--dir <path>] [--remote <url>]
Artifactsblobs [--prefix <p>] [--limit <n>] [--dir <path>] [--remote <url>]
Artifactsdelete --doc-key <key> [--expected-version <v>] [--dir <path>] [--remote <url>]
Kindsnew "<Kind>" <id> --<field> <value> [...] [--body <markdown> | --body-file <path>] [--link "<type>=<target-id>" ...] [--no-prefix] [--actor <n>] [--dir <path>] [--remote <url>]
Kindskinds [--dir <path>] [--remote <url>]
Kindskind field "<Kind>" (add <name> [--required] [--values <a,b,c>] | remove <name>) [--dir <path>] [--remote <url>]
Kindsrecipes [--dir <path>] [--remote <url>]
Kindsrecipe add <name-or-path> [--dir <path>] [--remote <url>]
Kindsrecipe evolve <name-or-path> [--apply <plan-token>] [--actor <name>] [--dir <path>] [--remote <url>]
Remoteserve [--dir <path>] [--host <h>] [--port <p>]
Remoteui [--dir <path> | --remote <url>] [--port <p>] [--open]
Remotemcp [install|status|uninstall | --dir <path>]
Remoteview list [--limit <n>] [--dir <path> | --remote <url>]
Remotesync [--establish [--yes] | --pull-only | --show-incoming <id> [--out <file>]] [--dir <path>] [--limit <n>]
Sessionversion [--check] [--tag latest|next] [--json]
Sessionsession-start [--dir <path>] [--no-update-check]
Sessionhook install|status|uninstall [--scope project|user]
Sessionskill install|status|uninstall [--scope project|user]
Sessionsetup [migrate-state|harden-state|quarantine-state] [--host codex|claude-code|claude-desktop|opencode] [--scope project|user] [--json]
<!-- END GENERATED CLI INVENTORY -->

Output modes

Ordinary successful receipts use compact TOON by default. Add --json when the command supports it and a machine needs JSON. Parse the selected structured form; avoid scraping descriptive help text.

Two commands deliberately reserve stdout for bytes:

  • doc read --out -, --body-out -, or --rendered-out - writes the requested bytes to stdout;

  • pull --out - writes canonical document or raw blob bytes to stdout.

In those modes receipts and errors move to stderr. mcp also reserves stdout for JSON-RPC and sends diagnostics to stderr. See CLI errors and exit codes for failures.

Command-family map

FamilyPrimary responsibility
BundleResolve, initialize, catalog, validate, and generate portable navigation
Documents and linksCreate, patch, read, open, query, version, delete, and relate documents
ArtifactsProduce Artifact records and move canonical documents or opaque bytes
KindsInspect and evolve bundle-declared conventions and reusable recipes
RemoteServe the reference protocol, launch the UI, expose MCP Apps, list Views, and sync Git boards
SessionReport build identity and install, inspect, or remove host integration

Stability and evidence

The command graph comes from tagged command-spec.ts and the packed executable help. Descriptions and defaults can change between pre-1.0 releases. Always pair automated usage with the release evidence and the exact command's help.