beads/docs/cli-reference
Chris Sells 8c974d8dc4
docs: align user docs and CLI reference with the v1.1.0 release (#4874)
* docs: align user docs and CLI reference with the v1.1.0 release

The Mintlify site publishes from main, so the docs had drifted ahead of the
latest release — documenting features that no released binary ships.

- Remove architecture/storage-backends: v1.1.0 supports only Dolt (the
  SQLite/Postgres/MySQL backends are post-tag work on main). Redirect the
  old routes to /architecture/dolt and drop the alternate-backend claims
  from README, core-concepts, architecture index, and FAQ.
- Stamp the docs homepage with the release: "These docs are for the 1.1.0
  release" plus a link to the v1.1.0 release notes.
- Regenerate the CLI reference (docs/cli-reference/, docs/CLI_REFERENCE.md,
  docs.json nav) from the released v1.1.0 binary via tools/docsmint: removes
  pages for post-1.1.0 commands (heartbeat, migrate-personal, reclaim,
  unclaim) and post-1.1.0 flags.
- Fix hand-written pages that referenced post-1.1.0 CLI surface, verified
  against the v1.1.0 binary: bd dep relate/unrelate (not top-level
  relate/unrelate), bd admin reset (not bd reset), bd hooks list (not
  status), bd history / bd vc status (not vc log/diff), release the claim
  via bd assign + bd update (no bd unclaim), drop bd migrate-personal and
  bd daemon mentions, and reduce the Cursor integration page to the rules
  file that v1.1.0's bd setup cursor actually installs.
- Stop documenting the BD_ALLOW_REMOTE_MIGRATE escape hatch (and the
  nonexistent-in-1.1.0 bd migrate --force): the remote-migrate gate prints
  its own operator guidance by design; docs now defer to it.

* docs: auto-regenerate CLI reference

Applied from the cli-docs-freshness-patch artifact of https://github.com/gastownhall/beads/actions/runs/29613329749
(generated with CI's canonical pinned build). See
scripts/check-cli-docs-drift.sh for how drift is attributed.

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-07-17 14:17:28 -07:00
..
admin.md docs(emitter): Cobra-accurate usage lines, published global flags, MDX ESM guard 2026-07-12 10:37:17 -07:00
ado.md docs(emitter): Cobra-accurate usage lines, published global flags, MDX ESM guard 2026-07-12 10:37:17 -07:00
assign.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
audit.md docs: regenerate CLI reference after rebase onto #4713 label changes 2026-07-12 10:38:32 -07:00
backup.md fix(claim): stop the refusal copy from teaching claim eviction (bd-at6rc) 2026-07-15 23:03:34 -07:00
batch.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
blocked.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
bootstrap.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
branch.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
children.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
close.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
comment.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
comments.md docs(emitter): Cobra-accurate usage lines, published global flags, MDX ESM guard 2026-07-12 10:37:17 -07:00
compact.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
completion.md docs(emitter): Cobra-accurate usage lines, published global flags, MDX ESM guard 2026-07-12 10:37:17 -07:00
config.md fix(claim): pool-claim parity for the proxied-server path + recognized claim.* config namespace (bd-bguz6) 2026-07-16 10:09:09 -07:00
context.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
cook.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
count.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
create-form.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
create.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
defer.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
delete.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
dep.md docs(emitter): Cobra-accurate usage lines, published global flags, MDX ESM guard 2026-07-12 10:37:17 -07:00
diff.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
doctor.md Revert "Simplify the supported backends: roll back the direct PostgreSQL and MySQL adapters" (#4857) 2026-07-16 16:35:51 -07:00
dolt.md docs(emitter): Cobra-accurate usage lines, published global flags, MDX ESM guard 2026-07-12 10:37:17 -07:00
duplicate.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
duplicates.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
edit.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
epic.md docs(emitter): Cobra-accurate usage lines, published global flags, MDX ESM guard 2026-07-12 10:37:17 -07:00
export.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
federation.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
find-duplicates.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
flatten.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
forget.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
formula.md docs(emitter): Cobra-accurate usage lines, published global flags, MDX ESM guard 2026-07-12 10:37:17 -07:00
gate.md docs: auto-regenerate CLI reference 2026-07-16 19:21:18 +00:00
gc.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
github.md docs(emitter): Cobra-accurate usage lines, published global flags, MDX ESM guard 2026-07-12 10:37:17 -07:00
gitlab.md docs(emitter): Cobra-accurate usage lines, published global flags, MDX ESM guard 2026-07-12 10:37:17 -07:00
graph.md feat(graph): add --open flag for LLM-friendly compact output (GH#3544) (#3778) 2026-07-14 10:17:30 -07:00
history.md docs: regenerate CLI reference after rebase onto #4713 label changes 2026-07-12 10:38:32 -07:00
hooks.md docs(emitter): Cobra-accurate usage lines, published global flags, MDX ESM guard 2026-07-12 10:37:17 -07:00
human.md docs(emitter): Cobra-accurate usage lines, published global flags, MDX ESM guard 2026-07-12 10:37:17 -07:00
import.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
index.md docs: regenerate CLI reference for global --no-color flag 2026-07-13 20:54:50 -07:00
info.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
init-safety.md fix(cli): printed doc paths point at the new docs locations 2026-07-12 10:37:17 -07:00
init.md docs: regenerate CLI reference for proxied-server external TLS flags 2026-07-16 16:44:26 -07:00
jira.md docs(emitter): Cobra-accurate usage lines, published global flags, MDX ESM guard 2026-07-12 10:37:17 -07:00
kv.md docs(emitter): Cobra-accurate usage lines, published global flags, MDX ESM guard 2026-07-12 10:37:17 -07:00
label.md docs: regenerate CLI reference after rebase onto #4713 label changes 2026-07-12 10:38:32 -07:00
linear.md docs(emitter): Cobra-accurate usage lines, published global flags, MDX ESM guard 2026-07-12 10:37:17 -07:00
link.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
lint.md Merge remote-tracking branch 'upstream/main' into pr-4337-fix 2026-07-13 20:40:05 -07:00
list.md docs: regenerate CLI reference for bd list --external-ref 2026-07-13 20:40:22 -07:00
mail.md docs(emitter): Cobra-accurate usage lines, published global flags, MDX ESM guard 2026-07-12 10:37:17 -07:00
memories.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
merge-slot.md docs(emitter): Cobra-accurate usage lines, published global flags, MDX ESM guard 2026-07-12 10:37:17 -07:00
metrics.md docs(emitter): Cobra-accurate usage lines, published global flags, MDX ESM guard 2026-07-12 10:37:17 -07:00
migrate.md docs: auto-regenerate CLI reference 2026-07-13 20:30:59 +00:00
mol.md docs: fix integration-page fact errors; restore three lost source edits 2026-07-12 10:37:18 -07:00
note.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
notion.md docs(emitter): Cobra-accurate usage lines, published global flags, MDX ESM guard 2026-07-12 10:37:17 -07:00
onboard.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
orphans.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
ping.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
preflight.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
prime.md Merge remote-tracking branch 'upstream/main' into pr-4336-fix 2026-07-13 21:42:55 -07:00
priority.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
promote.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
prune.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
purge.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
q.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
query.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
quickstart.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
ready.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
recall.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
recompute-blocked.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
remember.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
rename-prefix.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
rename.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
reopen.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
repo.md docs(emitter): Cobra-accurate usage lines, published global flags, MDX ESM guard 2026-07-12 10:37:17 -07:00
restore.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
rules.md docs(emitter): Cobra-accurate usage lines, published global flags, MDX ESM guard 2026-07-12 10:37:17 -07:00
search.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
set-state.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
setup.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
ship.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
show.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
sql.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
stale.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
state.md docs(emitter): Cobra-accurate usage lines, published global flags, MDX ESM guard 2026-07-12 10:37:17 -07:00
status.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
statuses.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
supersede.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
swarm.md docs(emitter): Cobra-accurate usage lines, published global flags, MDX ESM guard 2026-07-12 10:37:17 -07:00
tag.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
todo.md docs(emitter): Cobra-accurate usage lines, published global flags, MDX ESM guard 2026-07-12 10:37:17 -07:00
types.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
undefer.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
update.md feat(claim): pool-aware claiming via the claim.pools config key (bd-bguz6) 2026-07-16 10:09:09 -07:00
upgrade.md docs(emitter): Cobra-accurate usage lines, published global flags, MDX ESM guard 2026-07-12 10:37:17 -07:00
vc.md docs(emitter): Cobra-accurate usage lines, published global flags, MDX ESM guard 2026-07-12 10:37:17 -07:00
version.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
where.md docs(emitter): emit Mintlify CLI reference and generated docs.json nav 2026-07-12 10:37:07 -07:00
worktree.md docs(emitter): Cobra-accurate usage lines, published global flags, MDX ESM guard 2026-07-12 10:37:17 -07:00