The v1.0.5 tag shipped with cmd/bd/version.go bumped to 1.0.5 but without the Docusaurus version snapshot, so check-version-consistency (via scripts/check-docs-version.sh) went red on main: versions.json and docusaurus.config.ts lastVersion were still 1.0.4 and website/versioned_docs/version-1.0.5 was missing. Create the 1.0.5 docs snapshot to restore consistency: - docusaurus docs:version 1.0.5 (versions.json + versioned_docs + sidebar) - set docusaurus.config.ts lastVersion to 1.0.5 - regenerate versioned CLI reference (stamps "Reference for bd v1.0.5") - regenerate website/static/llms-full.txt Verified: scripts/check-versions.sh and scripts/check-doc-flags.sh pass. Refs: mybd-4qku Agent-Signature: claude-opus-4-8-medium on behalf of matt wilkie
1.9 KiB
| id | title | slug | sidebar_position |
|---|---|---|---|
| setup | bd setup | /cli-reference/setup | 410 |
Generated from bd help --doc setup
bd 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)