beads/website/versioned_docs/version-1.0.0/getting-started/ide-setup.md
Isaac Karrer 7f0a165f4e
feat(docs): version Docusaurus site and align llms-full with snapshots (#3033)
* feat(docs): version Docusaurus site and align llms-full with snapshots

Add docs version 1.0.0, version dropdown, lastVersion defaulting to stable,
merged markdown config, and RELEASING steps for future doc snapshots.
generate-llms-full.sh reads the latest entry in versions.json.

README links the published documentation site.

Closes #2644

Made-with: Cursor

* fix(docs): update org URLs to gastownhall and refresh 1.0.0 snapshot

- Update default orgName in docusaurus.config.ts from steveyegge to
  gastownhall to match the repo's new home
- Update hardcoded steveyegge URLs in generate-llms-full.sh
- Refresh versioned_docs 1.0.0 snapshot to include quickstart changes
  from #3032 which merged after the original snapshot was taken
- Regenerate llms-full.txt with corrected URLs and updated content

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: matt wilkie <maphew@gmail.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-06 21:12:54 -07:00

3.4 KiB

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 prime when Claude Code starts
  • PreCompact hook - Ensures bd dolt push before context compaction

How it works:

  1. SessionStart hook runs bd prime automatically
  2. bd prime injects ~1-2k tokens of workflow context
  3. You use bd CLI commands directly
  4. 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 dolt push"]
  }
}

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

GitHub Copilot

For VS Code with GitHub Copilot, use the MCP server:

# Install MCP server
uv tool install beads-mcp

Create .vscode/mcp.json in your project:

{
  "servers": {
    "beads": {
      "command": "beads-mcp"
    }
  }
}

For all projects: Add to VS Code user-level MCP config:

Platform Path
macOS ~/Library/Application Support/Code/User/mcp.json
Linux ~/.config/Code/User/mcp.json
Windows %APPDATA%\Code\User\mcp.json
{
  "servers": {
    "beads": {
      "command": "beads-mcp",
      "args": []
    }
  }
}

Initialize beads and reload VS Code:

bd init --quiet

See GitHub Copilot Integration for detailed setup.

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 project health
bd doctor

# Check hooks
bd hooks status

# Check editor integration
bd setup claude --check   # or cursor, aider