Merge GH#518 setup docs

This commit is contained in:
Steve Yegge
2025-12-16 01:18:51 -08:00
4 changed files with 19124 additions and 18 deletions

View File

@@ -133,15 +133,17 @@ brew install bd
cd your-project
bd init --quiet
# 3. Install hooks for automatic context injection
bd hooks install
# 3. Setup editor integration (choose one)
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
```
**How it works:**
- SessionStart hook runs `bd prime` automatically
- `bd prime` injects ~1-2k tokens of workflow context
- Editor hooks/rules inject `bd prime` automatically on session start
- `bd prime` provides ~1-2k tokens of workflow context
- You use `bd` CLI commands directly
- Git hooks auto-sync the database
- Git hooks (installed by `bd init`) auto-sync the database
**Why this is recommended:**
- **Context efficient** - ~1-2k tokens vs 10-50k for MCP tool schemas
@@ -149,6 +151,13 @@ bd hooks install
- **Universal** - Works with any editor that has shell access
- **More sustainable** - Less compute per request
**Verify installation:**
```bash
bd setup claude --check # Check Claude Code integration
bd setup cursor --check # Check Cursor integration
bd setup aider --check # Check Aider integration
```
### Claude Code Plugin (Optional)
For enhanced UX with slash commands: