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

60 lines
2.9 KiB
Markdown

---
id: ready
title: bd ready
slug: /cli-reference/ready
sidebar_position: 30
---
<!-- AUTO-GENERATED: do not edit manually -->
Generated from `bd help --doc ready`
## bd ready
Show ready work (open issues with no active blockers).
Excludes in_progress, blocked, deferred, and hooked issues. This uses the
GetReadyWork API which applies blocker-aware semantics to find truly claimable work.
Note: 'bd list --ready' uses the same blocker-aware ready-work semantics.
Use --mol to filter to a specific molecule's steps:
bd ready --mol bd-patrol # Show ready steps within molecule
Use --gated to find molecules ready for gate-resume dispatch:
bd ready --gated # Find molecules where a gate closed
Use --claim to atomically claim the first ready issue matching the filters:
bd ready --claim --json
This is useful for agents executing molecules to see which steps can run next.
```
bd ready [flags]
```
**Flags:**
```
-a, --assignee string Filter by assignee
--claim Atomically claim the first ready issue matching the filters
--exclude-label strings Exclude issues that have ANY of these labels
--exclude-type strings Exclude issue types from results (comma-separated or repeatable, e.g., --exclude-type=convoy,epic)
--explain Show dependency-aware reasoning for why issues are ready or blocked
--gated Find molecules ready for gate-resume dispatch
--has-metadata-key string Filter issues that have this metadata key set
--include-deferred Include issues with future defer_until timestamps
--include-ephemeral Include ephemeral issues (wisps) in results
-l, --label strings Filter by labels (AND: must have ALL). Can combine with --label-any
--label-any strings Filter by labels (OR: must have AT LEAST ONE). Can combine with --label
-n, --limit int Maximum issues to show (use 0 for unlimited) (default 100)
--metadata-field stringArray Filter by metadata field (key=value, repeatable)
--mol string Filter to steps within a specific molecule
--mol-type string Filter by molecule type: swarm, patrol, or work
--parent string Filter to descendants of this bead/epic
--plain Display issues as a plain numbered list
--pretty Display issues in a tree format with status/priority symbols (default true)
-p, --priority int Filter by priority
-s, --sort string Sort policy: priority (default), hybrid, oldest (default "priority")
-t, --type string Filter by issue type (task, bug, feature, epic, decision, merge-request). Aliases: mr→merge-request, feat→feature, mol→molecule, dec/adr→decision
-u, --unassigned Show only unassigned issues
```