beads/docs/cli-reference/comments.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.1 KiB

title description
bd comments View or manage comments on an issue

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

Generated from bd help --doc comments.

View or manage comments on an issue.

Examples:

List all comments on an issue (issue id is required — there is no "comments list")

bd comments bd-123

List comments in JSON format

bd comments bd-123 --json

Add a comment

bd comments add bd-123 "This is a comment"

Add a comment from a file

bd comments add bd-123 -f notes.txt

bd comments [issue-id] [flags]

Flags:

      --local-time   Show timestamps in local time instead of UTC

bd comments add

Add a comment to an issue.

Examples:

Add a comment

bd comments add bd-123 "Working on this now"

Add a comment from a file

bd comments add bd-123 -f notes.txt

bd comments add [issue-id] [text] [flags]

Flags:

  -a, --author string   Add author to comment
  -f, --file string     Read comment text from file

bd comments list

Invalid — use bd comments <issue-id> to list comments

bd comments list [flags]