beads/docs/cli-reference/kv.md
Chris Sells de0200ff77 docs(emitter): Cobra-accurate usage lines, published global flags, MDX ESM guard
Three generated-content defects from the adversarial review, all
structurally invisible to the drift gate (generated-vs-generated):

- Usage lines now mirror Cobra's help template: a runnable command shows
  its UseLine, a command with subcommands shows '<path> [command]', both
  when both apply. Previously bare UseLine() stamped 'bd mol [flags]' on
  30 parent pages — a line the binary never prints.
- The generated CLI index publishes the Global Flags block; the binary
  prints it on every --help but no page carried it.
- docsmint neutralizes prose lines that Mintlify's prebuild would dedent
  into MDX ESM blocks (a line beginning 'export'/'import' outside a
  fence gets wrapped in a code span). This is why /cli-reference/mail
  returned HTTP 200 while rendering only a parse-error placeholder —
  reproduced, fixed, and covered by a planted-hazard test; fenced
  content stays verbatim.

Also rewords check-cli-docs-drift.sh's early-PASS message, which
asserted 'the supplied binary differs' as the cause when uncommitted
local edits produce the same result.

All 113 pages + docs/CLI_REFERENCE.md regenerated through the pipeline;
TDD'd in cmd/bd/help_all_test.go and tools/docsmint/docsmint_test.go.
Verified live: /cli-reference/mail renders real content, zero parse
errors; generate-cli-docs.sh --check, docsync, freshness, and
mint broken-links all pass on this tree.
2026-07-12 10:37:17 -07:00

1.3 KiB

title description
bd kv Key-value store commands

{/* AUTO-GENERATED: do not edit manually */}

Generated from bd help --doc kv.

Commands for working with the beads key-value store.

The key-value store is useful for storing flags, environment variables, or other user-defined data that persists across sessions.

Examples: bd kv set mykey myvalue # Set a value bd kv get mykey # Get a value bd kv clear mykey # Delete a key bd kv list # List all key-value pairs

bd kv [command]

bd kv clear

Delete a key from the beads key-value store.

Examples: bd kv clear feature_flag bd kv clear api_endpoint

bd kv clear <key> [flags]

bd kv get

Get a value from the beads key-value store.

Examples: bd kv get feature_flag bd kv get api_endpoint

bd kv get <key> [flags]

bd kv list

List all key-value pairs in the beads key-value store.

Examples: bd kv list bd kv list --json

bd kv list [flags]

bd kv set

Set a key-value pair in the beads key-value store.

This is useful for storing flags, environment variables, or other user-defined data that persists across sessions.

Examples: bd kv set feature_flag true bd kv set api_endpoint https://api.example.com bd kv set max_retries 3

bd kv set <key> <value> [flags]