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.
59 lines
3.1 KiB
Markdown
59 lines
3.1 KiB
Markdown
---
|
|
title: "bd ready"
|
|
description: "Show ready work (open issues with no active blockers)."
|
|
---
|
|
|
|
{/* AUTO-GENERATED: do not edit manually */}
|
|
|
|
Generated from `bd help --doc 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
|
|
--offset int Skip the first N matching results (0-based). Only supported under --proxied-server.
|
|
--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
|
|
```
|