* 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>
49 lines
1.8 KiB
Markdown
49 lines
1.8 KiB
Markdown
---
|
|
id: setup
|
|
title: bd setup
|
|
slug: /cli-reference/setup
|
|
sidebar_position: 410
|
|
---
|
|
|
|
<!-- AUTO-GENERATED: do not edit manually -->
|
|
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, 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
|
|
bd setup codex --global # Install global Codex skill + global AGENTS.md guidance
|
|
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)
|
|
```
|