beads/docs/cli-reference/update.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

55 lines
3.1 KiB
Markdown

---
title: "bd update"
description: "Update one or more issues"
---
{/* AUTO-GENERATED: do not edit manually */}
Generated from `bd help --doc update`.
Update one or more issues.
If no issue ID is provided, updates the last touched issue (from most recent
create, update, show, or close operation).
```
bd update [id...] [flags]
```
**Flags:**
```
--acceptance string Acceptance criteria
--add-label strings Add labels (repeatable)
--allow-empty-description Allow empty description replacement when reading from stdin or file
--append-notes string Append to existing notes (with newline separator)
-a, --assignee string Assignee
--await-id string Set gate await_id (e.g., GitHub run ID for gh:run gates)
--body-file string Read description from file (use - for stdin)
--claim Atomically claim the issue (sets assignee to you, status to in_progress; idempotent if already claimed by you)
--defer string Defer until date (empty to clear). Issue hidden from bd ready until then
-d, --description string Issue description
--design string Design notes
--design-file string Read design from file (use - for stdin)
--due string Due date/time (empty to clear). Formats: +6h, +1d, +2w, tomorrow, next monday, 2025-01-15
--ephemeral Mark issue as ephemeral (wisp) - not exported to JSONL
-e, --estimate int Time estimate in minutes (e.g., 60 for 1 hour)
--external-ref string External reference (e.g., 'gh-9', 'jira-ABC', Linear URL)
--history Clear no-history flag (re-enable Dolt commit history)
--metadata string Set custom metadata (JSON string or @file.json to read from file)
--no-history Mark issue as no-history (skip Dolt commits, not GC-eligible)
--notes string Additional notes
--parent string New parent issue ID (reparents the issue, use empty string to remove parent)
--persistent Mark issue as persistent (promote wisp to regular issue)
-p, --priority string Priority (0-4 or P0-P4, 0=highest)
--remove-label strings Remove labels (repeatable)
--session string Claude Code session ID for status=closed (or set CLAUDE_SESSION_ID env var)
--set-labels strings Set labels, replacing all existing (repeatable)
--set-metadata stringArray Set metadata key=value (repeatable, e.g., --set-metadata team=platform)
--spec-id string Link to specification document
-s, --status string New status
--stdin Read description from stdin (alias for --body-file -)
--title string New title
-t, --type string New type (bug|feature|task|epic|chore|decision); custom types require types.custom config
--unset-metadata stringArray Remove metadata key (repeatable, e.g., --unset-metadata team)
```