beads/website/docs/cli-reference/kv.md
matt wilkie b2a4d1d04a
docs: generate CLI reference from live help (#3704)
* docs: generate CLI reference from live help

* docs(cli): move bd version stamp from per-command pages to index only

Drops the `(bd version X.Y.Z)` suffix from the auto-generated header on
every per-command CLI reference page (writeSingleCommandDoc) and the
docs/CLI_REFERENCE.md preamble (writeAllHelp). The version label now
lives only on the index page emitted by scripts/generate-cli-docs.sh:

- Dev tree (website/docs/cli-reference/index.md, docs/CLI_REFERENCE.md):
  labelled "Latest"
- Versioned snapshots (website/versioned_docs/version-X.Y.Z/...):
  labelled with the explicit semver tag parsed from the directory name

This eliminates the 100+-file no-signal diff a release version bump
otherwise produces, restoring the "regen as a separate small commit"
workflow PR #3704 enables. After this change a version bump alone
yields zero diff on the dev tree; only the new versioned snapshot
created at release-cut time carries the new tag. No datestamps are
introduced anywhere — scripts/generate-cli-docs.sh --check remains
deterministic across CI runs.

Refs: mybd-afb, PR #3704

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: CI Bot <ci@beads.test>
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-05 19:43:49 -07:00

1.3 KiB

id title slug sidebar_position
kv bd kv /cli-reference/kv 999

Generated from bd help --doc kv

bd 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

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>

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>

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

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>