Files
beads/cmd/bd/setup/claude.go
Ryan f7e80dd80c feat: add context optimization features for AI agents (#297)
* feat: add bd prime and setup commands for AI agent integration

This commit consolidates context optimization features for AI agents:

## New Commands

**bd prime** - AI-optimized workflow context injection
- Outputs ~1-2k tokens of workflow context
- Context-aware: adapts to MCP vs CLI mode
- MCP mode: minimal reminders (~500 tokens)
- CLI mode: full command reference (~1-2k tokens)
- Warns against TodoWrite tool and markdown TODOs
- Designed for SessionStart/PreCompact hooks

**bd setup claude** - Claude Code integration installer
- Installs hooks via JSON configuration (not file scripts)
- Supports --project for project-only installation
- Supports --check to verify installation
- Supports --remove to uninstall hooks
- Idempotent (safe to run multiple times)
- Merges with existing settings

**bd setup cursor** - Cursor IDE integration installer
- Creates .cursor/rules/beads.mdc with workflow rules
- Simplified implementation (just overwrites file)

## bd doctor Enhancements

- New: CheckClaude() verifies Claude Code integration
- Detects plugin, MCP server, and hooks installation
- Provides actionable fix suggestions
- Extracted legacy pattern detection to doctor/legacy.go
- Detects JSONL-only mode and warns about legacy issues.jsonl

## Core Improvements

- FindBeadsDir() utility for cross-platform .beads/ discovery
- Works in JSONL-only mode (no database required)
- Sorted noDbCommands alphabetically (one per line for easy diffs)

## Testing

- Unit tests for setup command hook manipulation
- Tests for idempotency, adding/removing hooks
- All tests passing

## Documentation

- cmd/bd/doctor/claude.md - Documents why beads doesn't use Claude Skills
- commands/prime.md - Slash command for bd prime
- Fixed G304 gosec warnings with nosec comments

## Token Efficiency

The bd prime approach reduces AI context usage dramatically:
- MCP mode: ~500 tokens (vs ~10.5k for full MCP tool scan)
- CLI mode: ~1-2k tokens
- 80-99% reduction in standing context overhead

* fix: resolve linting errors in setup utils and remove obsolete test

- Add error check for tmpFile.Close() in setup/utils.go to fix golangci-lint G104
- Remove TestCheckMultipleJSONLFiles test that referenced deleted checkMultipleJSONLFiles function

Fixes golangci-lint errcheck violations introduced in the bd prime/setup feature.
2025-11-12 10:48:36 -08:00

296 lines
7.1 KiB
Go

package setup
import (
"encoding/json"
"fmt"
"os"
"path/filepath"
)
// InstallClaude installs Claude Code hooks
func InstallClaude(project bool) {
var settingsPath string
if project {
settingsPath = ".claude/settings.local.json"
fmt.Println("Installing Claude hooks for this project...")
} else {
home, err := os.UserHomeDir()
if err != nil {
fmt.Fprintf(os.Stderr, "Error: failed to get home directory: %v\n", err)
os.Exit(1)
}
settingsPath = filepath.Join(home, ".claude/settings.json")
fmt.Println("Installing Claude hooks globally...")
}
// Ensure parent directory exists
if err := EnsureDir(filepath.Dir(settingsPath), 0755); err != nil {
fmt.Fprintf(os.Stderr, "Error: %v\n", err)
os.Exit(1)
}
// Load or create settings
var settings map[string]interface{}
data, err := os.ReadFile(settingsPath) // #nosec G304 -- settingsPath is constructed from user home dir, not user input
if err != nil {
settings = make(map[string]interface{})
} else {
if err := json.Unmarshal(data, &settings); err != nil {
fmt.Fprintf(os.Stderr, "Error: failed to parse settings.json: %v\n", err)
os.Exit(1)
}
}
// Get or create hooks section
hooks, ok := settings["hooks"].(map[string]interface{})
if !ok {
hooks = make(map[string]interface{})
settings["hooks"] = hooks
}
// Add SessionStart hook
if addHookCommand(hooks, "SessionStart", "bd prime") {
fmt.Println("✓ Registered SessionStart hook")
}
// Add PreCompact hook
if addHookCommand(hooks, "PreCompact", "bd prime") {
fmt.Println("✓ Registered PreCompact hook")
}
// Write back to file
data, err = json.MarshalIndent(settings, "", " ")
if err != nil {
fmt.Fprintf(os.Stderr, "Error: marshal settings: %v\n", err)
os.Exit(1)
}
if err := atomicWriteFile(settingsPath, data, 0644); err != nil {
fmt.Fprintf(os.Stderr, "Error: write settings: %v\n", err)
os.Exit(1)
}
fmt.Printf("\n✓ Claude Code integration installed\n")
fmt.Printf(" Settings: %s\n", settingsPath)
fmt.Println("\nRestart Claude Code for changes to take effect.")
}
// CheckClaude checks if Claude integration is installed
func CheckClaude() {
home, err := os.UserHomeDir()
if err != nil {
fmt.Fprintf(os.Stderr, "Error: failed to get home directory: %v\n", err)
os.Exit(1)
}
globalSettings := filepath.Join(home, ".claude/settings.json")
projectSettings := ".claude/settings.local.json"
globalHooks := hasBeadsHooks(globalSettings)
projectHooks := hasBeadsHooks(projectSettings)
if globalHooks {
fmt.Println("✓ Global hooks installed:", globalSettings)
} else if projectHooks {
fmt.Println("✓ Project hooks installed:", projectSettings)
} else {
fmt.Println("✗ No hooks installed")
fmt.Println(" Run: bd setup claude")
os.Exit(1)
}
}
// RemoveClaude removes Claude Code hooks
func RemoveClaude(project bool) {
var settingsPath string
if project {
settingsPath = ".claude/settings.local.json"
fmt.Println("Removing Claude hooks from project...")
} else {
home, err := os.UserHomeDir()
if err != nil {
fmt.Fprintf(os.Stderr, "Error: failed to get home directory: %v\n", err)
os.Exit(1)
}
settingsPath = filepath.Join(home, ".claude/settings.json")
fmt.Println("Removing Claude hooks globally...")
}
// Load settings
data, err := os.ReadFile(settingsPath) // #nosec G304 -- settingsPath is constructed from user home dir, not user input
if err != nil {
fmt.Println("No settings file found")
return
}
var settings map[string]interface{}
if err := json.Unmarshal(data, &settings); err != nil {
fmt.Fprintf(os.Stderr, "Error: failed to parse settings.json: %v\n", err)
os.Exit(1)
}
hooks, ok := settings["hooks"].(map[string]interface{})
if !ok {
fmt.Println("No hooks found")
return
}
// Remove bd prime hooks
removeHookCommand(hooks, "SessionStart", "bd prime")
removeHookCommand(hooks, "PreCompact", "bd prime")
// Write back
data, err = json.MarshalIndent(settings, "", " ")
if err != nil {
fmt.Fprintf(os.Stderr, "Error: marshal settings: %v\n", err)
os.Exit(1)
}
if err := atomicWriteFile(settingsPath, data, 0644); err != nil {
fmt.Fprintf(os.Stderr, "Error: write settings: %v\n", err)
os.Exit(1)
}
fmt.Println("✓ Claude hooks removed")
}
// addHookCommand adds a hook command to an event if not already present
// Returns true if hook was added, false if already exists
func addHookCommand(hooks map[string]interface{}, event, command string) bool {
// Get or create event array
eventHooks, ok := hooks[event].([]interface{})
if !ok {
eventHooks = []interface{}{}
}
// Check if bd hook already registered
for _, hook := range eventHooks {
hookMap, ok := hook.(map[string]interface{})
if !ok {
continue
}
commands, ok := hookMap["hooks"].([]interface{})
if !ok {
continue
}
for _, cmd := range commands {
cmdMap, ok := cmd.(map[string]interface{})
if !ok {
continue
}
if cmdMap["command"] == command {
fmt.Printf("✓ Hook already registered: %s\n", event)
return false
}
}
}
// Add bd hook to array
newHook := map[string]interface{}{
"matcher": "",
"hooks": []interface{}{
map[string]interface{}{
"type": "command",
"command": command,
},
},
}
eventHooks = append(eventHooks, newHook)
hooks[event] = eventHooks
return true
}
// removeHookCommand removes a hook command from an event
func removeHookCommand(hooks map[string]interface{}, event, command string) {
eventHooks, ok := hooks[event].([]interface{})
if !ok {
return
}
// Filter out bd prime hooks
var filtered []interface{}
for _, hook := range eventHooks {
hookMap, ok := hook.(map[string]interface{})
if !ok {
filtered = append(filtered, hook)
continue
}
commands, ok := hookMap["hooks"].([]interface{})
if !ok {
filtered = append(filtered, hook)
continue
}
keepHook := true
for _, cmd := range commands {
cmdMap, ok := cmd.(map[string]interface{})
if !ok {
continue
}
if cmdMap["command"] == command {
keepHook = false
fmt.Printf("✓ Removed %s hook\n", event)
break
}
}
if keepHook {
filtered = append(filtered, hook)
}
}
hooks[event] = filtered
}
// hasBeadsHooks checks if a settings file has bd prime hooks
func hasBeadsHooks(settingsPath string) bool {
data, err := os.ReadFile(settingsPath) // #nosec G304 -- settingsPath is constructed from known safe locations (user home/.claude), not user input
if err != nil {
return false
}
var settings map[string]interface{}
if err := json.Unmarshal(data, &settings); err != nil {
return false
}
hooks, ok := settings["hooks"].(map[string]interface{})
if !ok {
return false
}
// Check SessionStart and PreCompact for "bd prime"
for _, event := range []string{"SessionStart", "PreCompact"} {
eventHooks, ok := hooks[event].([]interface{})
if !ok {
continue
}
for _, hook := range eventHooks {
hookMap, ok := hook.(map[string]interface{})
if !ok {
continue
}
commands, ok := hookMap["hooks"].([]interface{})
if !ok {
continue
}
for _, cmd := range commands {
cmdMap, ok := cmd.(map[string]interface{})
if !ok {
continue
}
if cmdMap["command"] == "bd prime" {
return true
}
}
}
}
return false
}