beads/docs/cli-reference/kv.md
Chris Sells 4ea6fa3ac0 docs(emitter): emit Mintlify CLI reference and generated docs.json nav
bd help --docs-root now additionally writes docs/cli-reference/ in Mintlify
form (frontmatter title as H1, extensionless root-relative links, JSX
auto-generated markers since Mintlify parses .md through MDX) and rewrites
the CLI Reference pages array inside docs/docs.json via a textual splice
that leaves the rest of the file byte-identical — the ~113 nav entries are
never hand-maintained. The Docusaurus outputs (docs/CLI_REFERENCE.md,
website/docs/cli-reference/, versioned snapshots) are unchanged.

generate-cli-docs.sh --check seeds docs/docs.json and docs/cli-reference/
into its scratch root and diffs both; check-cli-docs-drift.sh adds them to
GEN_PATHSPECS and the regeneration fingerprint; docs-autofix-push.sh
allowlists the new generated paths; check-doc-flags.sh scans the new
docs/ subdirectories and requires command coverage in docs/cli-reference/.

Includes the initial docs/docs.json scaffold (nav mirrors the Docusaurus
sidebar IA) and the generated docs/cli-reference/ pages.

TDD: new emitter behavior covered in cmd/bd/help_all_test.go
(Mintlify page format, nav splice correctness + idempotence, bare-root
generation without docs.json).
2026-07-12 10:37:07 -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 [flags]

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]