Docs

Docs

Docs is the user's filesystem-first document library. Documents can live on the server machine or another connected host, but the bb docs command handles that routing through named vaults.

Access documents

Start with the smallest useful lookup:

bb docs vaults --json
bb docs list --vault <vault-id> --json
bb docs read <path> --vault <vault-id>

Use the path and vault exactly as returned. Paths are relative to the vault; do not guess an absolute host path or inspect the vault outside bb docs.

Docs @-mentions

A Docs mention resolves at send time and appears in agent context as a Docs document (<vault>/<path>) block. Treat that block as user-provided source material from their document library:

• Read and use its current contents even if the prompt only says “this” or “the attached doc.”
• Preserve its meaning and distinguish its claims from your own inference.
• Do not rewrite the mentioned document unless the user asks you to change it.
• When your answer refers the user back to it, emit a Docs directive rather than an opaque filesystem path.

Create and update documents

Docs is a good destination for durable plans, specifications, write-ups, and HTML artifacts the user should be able to reopen.

bb docs pull plans/release-plan.md --vault personal --into ./docs-work
# Edit ./docs-work/plans/release-plan.md with normal file tools.
bb docs status ./docs-work --diff
bb docs push ./docs-work

bb docs status exits 0 when no changes exist. It exits 4 when it finds changes that the output describes. Exit 4 is a successful status result. Review that output, then run bb docs push as a separate command. Do not connect the status and push commands with &&.

Pull a folder subtree with --folder, or the whole selected vault with --all:

bb docs pull plans --folder --vault personal --into ./docs-work
bb docs pull --all --vault personal --into ./docs-work

Always edit the pulled files with ordinary workspace tools, then run status before push. The manifest in .bb-docs-state.json records stable vault paths and remote SHA-256 versions; do not edit it. Pull and push fail closed when both the local and vault copies changed. Resolve the content manually, then pull or push again. push --dry-run --diff previews without writing.

Local file and empty-directory deletions are ignored by default. Only use push --delete when the user explicitly asked to delete the corresponding vault paths. A pulled folder root is intentionally retained; pull its parent or the whole vault to remove that folder. Binary assets round-trip with their original bytes. If state is malformed, preserve the directory for recovery and pull into a new clean --into directory.

The direct write, mkdir, move, and remove commands are deprecated. Do not use them for agent edits; they remain temporarily available only for backward compatibility.

Run bb docs --help for the command list and bb docs <command> --help for a command's arguments, options, and rules. Each command accepts only the options its help lists; an unknown command, unknown option, or stray argument exits 2 before touching a vault, and with --json the failure also prints {"ok":false,"error":{"code","message","hint"?}} on stdout.

Use Markdown for documents and plans. Use a self-contained .html file for a visual artifact or interactive report; relative assets can live beside it. Only write into Docs when the user asks to create, save, store, or update something there.