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.
62 lines
2.0 KiB
Markdown
62 lines
2.0 KiB
Markdown
---
|
|
title: "bd graph"
|
|
description: "Display a visualization of an issue's dependency graph."
|
|
---
|
|
|
|
{/* AUTO-GENERATED: do not edit manually */}
|
|
|
|
Generated from `bd help --doc graph`.
|
|
|
|
Display a visualization of an issue's dependency graph.
|
|
|
|
For epics, shows all children and their dependencies.
|
|
For regular issues, shows the issue and its direct dependencies.
|
|
|
|
With --all, shows all open issues grouped by connected component.
|
|
|
|
Display formats:
|
|
(default) DAG with columns and box-drawing edges (terminal-native)
|
|
--box ASCII boxes showing layers, more detailed
|
|
--compact Tree format, one line per issue, more scannable
|
|
--dot Graphviz DOT format (pipe to dot -Tsvg > graph.svg)
|
|
--html Self-contained interactive HTML with D3.js visualization
|
|
|
|
The graph shows execution order:
|
|
- Layer 0 / leftmost = no dependencies (can start immediately)
|
|
- Higher layers depend on lower layers
|
|
- Nodes in the same layer can run in parallel
|
|
|
|
Status icons: ○ open ◐ in_progress ● blocked ✓ closed ❄ deferred
|
|
|
|
Examples:
|
|
bd graph issue-id # Terminal DAG visualization (default)
|
|
bd graph --box issue-id # ASCII boxes with layer grouping
|
|
bd graph --dot issue-id | dot -Tsvg > graph.svg # SVG via Graphviz
|
|
bd graph --dot issue-id | dot -Tpng > graph.png # PNG via Graphviz
|
|
bd graph --html issue-id > graph.html # Interactive browser view
|
|
bd graph --all --html > all.html # All issues, interactive
|
|
|
|
```
|
|
bd graph [issue-id] [flags]
|
|
```
|
|
|
|
**Flags:**
|
|
|
|
```
|
|
--all Show graph for all open issues
|
|
--box ASCII boxes showing layers
|
|
--compact Tree format, one line per issue, more scannable
|
|
--dot Output Graphviz DOT format (pipe to: dot -Tsvg > graph.svg)
|
|
--html Output self-contained interactive HTML (redirect to file)
|
|
```
|
|
|
|
## bd graph check
|
|
|
|
Check the dependency graph for cycles, orphans, and other integrity issues.
|
|
|
|
Returns exit code 0 if the graph is clean, 1 if issues are found.
|
|
|
|
```
|
|
bd graph check [flags]
|
|
```
|