mirror of
https://github.com/gastownhall/beads.git
synced 2026-09-14 20:17:24 +08:00
Chris Sells
d2f87d50de
* docs(pipeline): pin the generated CLI docs to the released bd; repair main's CLI reference The #4874 squash-merge raced the docs-autofix bot: the bot had pushed a regeneration from main's source onto the PR branch, so the squash landed a contradictory mix — the release-aligned hand-written docs plus a CLI reference re-documenting unreleased commands and flags, with docs.json referencing four pages (heartbeat, migrate-personal, reclaim, unclaim) whose files do not exist. That broken nav fails the docsync guard on main and on every branch cut from it. This restores the intended end state of #4874 and lands the pin that prevents the race from recurring. - Regenerate the CLI reference from a bd built from the v1.1.0 tag (CI's canonical pure-Go build), removing the unreleased commands/flags and fixing the dangling nav entries. - docs/cli-docs.pin names the release tag; scripts/resolve-docs-bd.sh builds and caches a canonical pure-Go bd from that tag, fetching the tag first in shallow CI checkouts. - generate-cli-docs.sh, check-doc-flags.sh, and check-cli-docs-drift.sh resolve bd through the pin and ignore a supplied binary while pinned (BD_DOCS_IGNORE_PIN=1 bypasses), so the drift gates and the autofix bot now enforce docs-match-release instead of docs-match-main. - tools/docsmint detects the pre-overhaul Docusaurus staging layout that bd <= v1.1.0 emits and converts it to the generic form before its normal Mintlify transform (tested); removable once the pin reaches a release whose emitter writes build/cli-docs. - check-doc-flags.sh: run without timeout(1) on macOS instead of failing Check 4. - Decision record: engdocs/decisions/2026-07-17-docs-release-pin.md; the beads-docs skill §8 updated to match. * lint: annotate gosec G705 false positive in the docsmint legacy bridge Same class as the existing nav-splice annotation: a developer tool writing repo Markdown, not a web-output sink.
64 lines
3.9 KiB
Markdown
64 lines
3.9 KiB
Markdown
---
|
|
title: "bd create"
|
|
description: "Create a new issue (or batch from markdown/graph JSON)"
|
|
---
|
|
|
|
{/* AUTO-GENERATED: do not edit manually */}
|
|
|
|
Generated from `bd help --doc create`.
|
|
|
|
Create a new issue (or batch from markdown/graph JSON)
|
|
|
|
```
|
|
bd create [title] [flags]
|
|
```
|
|
|
|
**Aliases:** new
|
|
|
|
**Flags:**
|
|
|
|
```
|
|
--acceptance string Acceptance criteria
|
|
--append-notes string Append to existing notes (with newline separator)
|
|
-a, --assignee string Assignee
|
|
--body-file string Read description from file (use - for stdin)
|
|
--context string Additional context for the issue
|
|
--defer string Defer until date (issue hidden from bd ready until then). Same formats as --due
|
|
--deps strings Dependencies in format 'type:id' or 'id' (e.g., 'discovered-from:bd-20,blocks:bd-15' or 'bd-20')
|
|
-d, --description string Issue description
|
|
--design string Design notes
|
|
--design-file string Read design from file (use - for stdin)
|
|
--dry-run Preview what would be created without actually creating
|
|
--due string Due date/time. Formats: +6h, +1d, +2w, tomorrow, next monday, 2025-01-15
|
|
--ephemeral Create as ephemeral (short-lived, subject to TTL compaction)
|
|
-e, --estimate int Time estimate in minutes (e.g., 60 for 1 hour)
|
|
--event-actor string Entity URI who caused this event (requires --type=event)
|
|
--event-category string Event category (e.g., patrol.muted, agent.started) (requires --type=event)
|
|
--event-payload string Event-specific JSON data (requires --type=event)
|
|
--event-target string Entity URI or bead ID affected (requires --type=event)
|
|
--external-ref string External reference (e.g., 'gh-9', 'jira-ABC', Linear URL)
|
|
-f, --file string Create multiple issues from markdown file
|
|
--force Force creation even if prefix doesn't match database prefix
|
|
--graph string Create a graph of issues with dependencies from JSON plan file
|
|
--id string Explicit issue ID (e.g., 'bd-42' for partitioning)
|
|
-l, --labels strings Labels (comma-separated)
|
|
--metadata string Set custom metadata (JSON string or @file.json to read from file)
|
|
--mol-type string Molecule type: swarm (multi-agent), patrol (recurring ops), work (default)
|
|
--no-history Skip Dolt commit history without making GC-eligible (for permanent agent beads)
|
|
--no-inherit-labels Don't inherit labels from parent issue
|
|
--notes string Additional notes
|
|
--parent string Parent issue ID for hierarchical child (e.g., 'bd-a3f8e9')
|
|
-p, --priority string Priority (0-4 or P0-P4, 0=highest) (default "2")
|
|
--repo string Target repository for issue (overrides auto-routing)
|
|
--silent Output only the issue ID (for scripting)
|
|
--skills string Required skills for this issue
|
|
--spec-id string Link to specification document
|
|
--stdin Read description from stdin (alias for --body-file -)
|
|
--title string Issue title (alternative to positional argument)
|
|
-t, --type string Issue type (bug|feature|task|epic|chore|decision); custom types require types.custom config; aliases: enhancement/feat→feature, dec/adr→decision (default "task")
|
|
--validate Validate description contains required sections for issue type
|
|
--waits-for string Spawner issue ID to wait for (creates waits-for dependency for fanout gate)
|
|
--waits-for-gate string Gate type: all-children (wait for all) or any-children (wait for first) (default "all-children")
|
|
--wisp-type string Wisp type for TTL-based compaction: heartbeat, ping, patrol, gc_report, recovery, error, escalation
|
|
```
|