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.
48 lines
2.0 KiB
Markdown
48 lines
2.0 KiB
Markdown
---
|
|
title: "bd setup"
|
|
description: "Setup integration files for AI editors and coding assistants."
|
|
---
|
|
|
|
{/* AUTO-GENERATED: do not edit manually */}
|
|
|
|
Generated from `bd help --doc setup`.
|
|
|
|
Setup integration files for AI editors and coding assistants.
|
|
|
|
Recipes define where beads workflow instructions are written. Built-in recipes
|
|
include cursor, claude, copilot, gemini, aider, factory, codex, mux, opencode, junie, windsurf, cody, and kilocode.
|
|
|
|
Examples:
|
|
bd setup cursor # Install Cursor IDE integration
|
|
bd setup codex # Install Codex skill + AGENTS.md guidance + native hooks
|
|
bd setup codex --global # Install global Codex skill + guidance + native hooks
|
|
bd setup copilot # Install Copilot CLI plugin + repository instructions
|
|
bd setup mux --project # Install Mux workspace layer (.mux/AGENTS.md)
|
|
bd setup mux --global # Install Mux global layer (~/.mux/AGENTS.md)
|
|
bd setup mux --project --global # Install both Mux layers
|
|
bd setup --list # Show all available recipes
|
|
bd setup --print # Print the template to stdout
|
|
bd setup -o rules.md # Write template to custom path
|
|
bd setup --add myeditor .myeditor/rules.md # Add custom recipe
|
|
|
|
Use 'bd setup <recipe> --check' to verify installation status.
|
|
Use 'bd setup <recipe> --remove' to uninstall.
|
|
|
|
```
|
|
bd setup [recipe] [flags]
|
|
```
|
|
|
|
**Flags:**
|
|
|
|
```
|
|
--add string Add a custom recipe with given name
|
|
--check Check if integration is installed
|
|
--global Install globally (claude/codex/mux; writes to ~/.claude/settings.json, $CODEX_HOME/AGENTS.md or ~/.codex/AGENTS.md, or ~/.mux/AGENTS.md)
|
|
--list List all available recipes
|
|
-o, --output string Write template to custom path
|
|
--print Print the template to stdout
|
|
--project Install for this project only (gemini/mux)
|
|
--remove Remove the integration
|
|
--stealth Use stealth mode (claude/gemini)
|
|
```
|