beads/website/versioned_docs/version-1.0.0/cli-reference/comments.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.1 KiB

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

Generated from bd help --doc comments

bd 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