docs: document bd setup command
Add comprehensive documentation for the bd setup command which was largely undocumented (GH#518): - CLI_REFERENCE.md: Add new "Editor Integration" section documenting bd setup claude/cursor/aider commands with all flags - INSTALLING.md: Fix incorrect reference to "bd hooks install" for editor integration - should be "bd setup <editor>" - CLAUDE_INTEGRATION.md: Add Installation section with bd setup claude examples Fixes: GH#518 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
@@ -11,6 +11,7 @@
|
||||
- [Filtering & Search](#filtering--search)
|
||||
- [Advanced Operations](#advanced-operations)
|
||||
- [Database Management](#database-management)
|
||||
- [Editor Integration](#editor-integration)
|
||||
|
||||
## Basic Operations
|
||||
|
||||
@@ -550,6 +551,44 @@ bd sync # Force immediate sync, bypass debounce
|
||||
|
||||
**ALWAYS run `bd sync` at end of agent sessions** to ensure changes are committed/pushed immediately.
|
||||
|
||||
## Editor Integration
|
||||
|
||||
### Setup Commands
|
||||
|
||||
```bash
|
||||
# Setup editor integration (choose based on your editor)
|
||||
bd setup claude # Claude Code - installs SessionStart/PreCompact hooks
|
||||
bd setup cursor # Cursor IDE - creates .cursor/rules/beads.mdc
|
||||
bd setup aider # Aider - creates .aider.conf.yml
|
||||
|
||||
# Check if integration is installed
|
||||
bd setup claude --check
|
||||
bd setup cursor --check
|
||||
bd setup aider --check
|
||||
|
||||
# Remove integration
|
||||
bd setup claude --remove
|
||||
bd setup cursor --remove
|
||||
bd setup aider --remove
|
||||
```
|
||||
|
||||
**Claude Code options:**
|
||||
```bash
|
||||
bd setup claude # Install globally (~/.claude/settings.json)
|
||||
bd setup claude --project # Install for this project only
|
||||
bd setup claude --stealth # Use stealth mode (flush only, no git operations)
|
||||
```
|
||||
|
||||
**What each setup does:**
|
||||
- **Claude Code** (`bd setup claude`): Adds hooks to Claude Code's settings.json that run `bd prime` on SessionStart and PreCompact events
|
||||
- **Cursor** (`bd setup cursor`): Creates `.cursor/rules/beads.mdc` with workflow instructions
|
||||
- **Aider** (`bd setup aider`): Creates `.aider.conf.yml` with bd workflow instructions
|
||||
|
||||
See also:
|
||||
- [INSTALLING.md](INSTALLING.md#ide-and-editor-integrations) - Installation guide
|
||||
- [AIDER_INTEGRATION.md](AIDER_INTEGRATION.md) - Detailed Aider guide
|
||||
- [CLAUDE_INTEGRATION.md](CLAUDE_INTEGRATION.md) - Claude integration design
|
||||
|
||||
## See Also
|
||||
|
||||
- [AGENTS.md](../AGENTS.md) - Main agent workflow guide
|
||||
|
||||
Reference in New Issue
Block a user