* 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>
124 lines
3 KiB
Markdown
124 lines
3 KiB
Markdown
---
|
|
id: swarm
|
|
title: bd swarm
|
|
slug: /cli-reference/swarm
|
|
sidebar_position: 999
|
|
---
|
|
|
|
<!-- AUTO-GENERATED: do not edit manually -->
|
|
Generated from `bd help --doc swarm`
|
|
|
|
## bd swarm
|
|
|
|
Swarm management commands for coordinating parallel work on epics.
|
|
|
|
A swarm is a structured body of work defined by an epic and its children,
|
|
with dependencies forming a DAG (directed acyclic graph) of work.
|
|
|
|
```
|
|
bd swarm
|
|
```
|
|
|
|
### bd swarm create
|
|
|
|
Create a swarm molecule to orchestrate parallel work on an epic.
|
|
|
|
The swarm molecule:
|
|
- Links to the epic it orchestrates
|
|
- Has mol_type=swarm for discovery
|
|
- Specifies a coordinator (optional)
|
|
- Can be picked up by any coordinator agent
|
|
|
|
If given a single issue (not an epic), it will be auto-wrapped:
|
|
- Creates an epic with that issue as its only child
|
|
- Then creates the swarm molecule for that epic
|
|
|
|
Examples:
|
|
bd swarm create bd-epic-123 # Create swarm for epic
|
|
bd swarm create bd-epic-123 --coordinator=observer/ # With specific coordinator
|
|
bd swarm create bd-task-456 # Auto-wrap single issue
|
|
|
|
```
|
|
bd swarm create [epic-id] [flags]
|
|
```
|
|
|
|
**Flags:**
|
|
|
|
```
|
|
--coordinator string Coordinator address (e.g., my-project/witness)
|
|
--force Create new swarm even if one already exists
|
|
```
|
|
|
|
### bd swarm list
|
|
|
|
List all swarm molecules with their status.
|
|
|
|
Shows each swarm molecule with:
|
|
- Progress (completed/total issues)
|
|
- Active workers
|
|
- Epic ID and title
|
|
|
|
Examples:
|
|
bd swarm list # List all swarms
|
|
bd swarm list --json # Machine-readable output
|
|
|
|
```
|
|
bd swarm list
|
|
```
|
|
|
|
### bd swarm status
|
|
|
|
Show the current status of a swarm, computed from beads.
|
|
|
|
Accepts either:
|
|
- An epic ID (shows status for that epic's children)
|
|
- A swarm molecule ID (follows the link to find the epic)
|
|
|
|
Displays issues grouped by state:
|
|
- Completed: Closed issues
|
|
- Active: Issues currently in_progress (with assignee)
|
|
- Ready: Open issues with all dependencies satisfied
|
|
- Blocked: Open issues waiting on dependencies
|
|
|
|
The status is COMPUTED from beads, not stored separately.
|
|
If beads changes, status changes.
|
|
|
|
Examples:
|
|
bd swarm status gt-epic-123 # Show swarm status by epic
|
|
bd swarm status gt-swarm-456 # Show status via swarm molecule
|
|
bd swarm status gt-epic-123 --json # Machine-readable output
|
|
|
|
```
|
|
bd swarm status [epic-or-swarm-id]
|
|
```
|
|
|
|
### bd swarm validate
|
|
|
|
Validate an epic's structure to ensure it's ready for swarm execution.
|
|
|
|
Checks for:
|
|
- Correct dependency direction (requirement-based, not temporal)
|
|
- Orphaned issues (roots with no dependents)
|
|
- Missing dependencies (leaves that should depend on something)
|
|
- Cycles (impossible to resolve)
|
|
- Disconnected subgraphs
|
|
|
|
Reports:
|
|
- Ready fronts (waves of parallel work)
|
|
- Estimated worker-sessions
|
|
- Maximum parallelism
|
|
- Warnings for potential issues
|
|
|
|
Examples:
|
|
bd swarm validate gt-epic-123 # Validate epic structure
|
|
bd swarm validate gt-epic-123 --verbose # Include detailed issue graph
|
|
|
|
```
|
|
bd swarm validate [epic-id] [flags]
|
|
```
|
|
|
|
**Flags:**
|
|
|
|
```
|
|
--verbose Include detailed issue graph in output
|
|
```
|