Cherry-picked website/, scripts/generate-llms-full.sh, and deploy-docs.yml from joyshmitz's PR. Fixed workflow to trigger on main branch instead of docs/docusaurus-site. Features: - Docusaurus documentation site with llms.txt support - Environment-variable driven config (defaults to steveyegge org) - Automated llms-full.txt generation from docs - GitHub Pages deployment workflow Co-authored-by: joyshmitz <joyshmitz@users.noreply.github.com> 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> Executed-By: beads/crew/dave Rig: beads Role: crew
2.6 KiB
2.6 KiB
id, title, sidebar_position
| id | title | sidebar_position |
|---|---|---|
| ide-setup | IDE Setup | 3 |
IDE Setup for AI Agents
Configure your IDE for optimal beads integration.
Claude Code
The recommended approach for Claude Code:
# Setup Claude Code integration
bd setup claude
This installs:
- SessionStart hook - Runs
bd primewhen Claude Code starts - PreCompact hook - Ensures
bd syncbefore context compaction
How it works:
- SessionStart hook runs
bd primeautomatically bd primeinjects ~1-2k tokens of workflow context- You use
bdCLI commands directly - Git hooks auto-sync the database
Verify installation:
bd setup claude --check
Manual Setup
If you prefer manual configuration, add to your Claude Code hooks:
{
"hooks": {
"SessionStart": ["bd prime"],
"PreCompact": ["bd sync"]
}
}
Cursor IDE
# Setup Cursor integration
bd setup cursor
This creates .cursor/rules/beads.mdc with beads-aware rules.
Verify:
bd setup cursor --check
Aider
# Setup Aider integration
bd setup aider
This creates/updates .aider.conf.yml with beads context.
Verify:
bd setup aider --check
Context Injection with bd prime
All integrations use bd prime to inject context:
bd prime
This outputs a compact (~1-2k tokens) workflow reference including:
- Available commands
- Current project status
- Workflow patterns
- Best practices
Why context efficiency matters:
- Compute cost scales with tokens
- Latency increases with context size
- Models attend better to smaller, focused contexts
MCP Server (Alternative)
For MCP-only environments (Claude Desktop, no shell access):
# Install MCP server
pip install beads-mcp
Add to Claude Desktop config:
{
"mcpServers": {
"beads": {
"command": "beads-mcp"
}
}
}
Trade-offs:
- Works in MCP-only environments
- Higher context overhead (10-50k tokens for tool schemas)
- Additional latency from MCP protocol
See MCP Server for detailed configuration.
Git Hooks
Ensure git hooks are installed for auto-sync:
bd hooks install
This installs:
- pre-commit - Validates changes before commit
- post-merge - Imports changes after pull
- pre-push - Ensures sync before push
Check hook status:
bd info # Shows warnings if hooks are outdated
Verifying Your Setup
Run a complete health check:
# Check version
bd version
# Check daemon
bd info
# Check hooks
bd hooks status
# Check editor integration
bd setup claude --check # or cursor, aider