sqlew 4.0.4 → 4.1.0

package/docs/HOOKS_GUIDE.md

@@ -0,0 +1,159 @@
+# Claude Code Hooks Guide
+
+Integration guide for sqlew with Claude Code hooks.
+
+## Overview
+
+sqlew integrates with Claude Code through PreToolUse and PostToolUse hooks, enabling automatic decision tracking during AI-assisted development.
+
+## Architecture
+
+```
+Claude Code                    sqlew
+    │                            │
+    ├─ PreToolUse ──────────────►│ suggest (related decisions)
+    │                            │
+    ├─ Tool Execution            │
+    │                            │
+    ├─ PostToolUse ─────────────►│ track-plan, save, check-completion
+    │                            │
+    └─ (Git hooks) ─────────────►│ mark-done (post-merge, post-rewrite)
+```
+
+## File Queue Architecture
+
+Hooks use a file-based queue for async operations:
+
+1. **Hook writes to queue** (fast, <100ms)
+   - Location: `.sqlew/queue/pending.json`
+2. **QueueWatcher detects change** (MCP server)
+3. **Decisions registered in DB** (async)
+
+This architecture ensures zero latency on code edits.
+
+## Installation
+
+```bash
+# Initialize hooks in your project
+sqlew init --hooks
+
+# Without Git hooks (MCP hooks only)
+sqlew init --hooks --no-git
+```
+
+This creates `.claude/settings.local.json` with hook configuration.
+
+## Hook Commands
+
+### PreToolUse Hooks
+
+| Trigger | Command | Purpose |
+|---------|---------|---------|
+| Task | `sqlew suggest` | Suggest related decisions before Task creation |
+| Write | `sqlew track-plan` | Track plan ID during planning |
+
+### PostToolUse Hooks
+
+| Trigger | Command | Purpose |
+|---------|---------|---------|
+| Edit, Write | `sqlew save` | Enqueue decision updates |
+| TodoWrite | `sqlew check-completion` | Check task completion status |
+| ExitPlanMode | `sqlew save` | Save plan state on exit |
+
+### Git Hooks
+
+| Trigger | Command | Purpose |
+|---------|---------|---------|
+| post-merge | `sqlew mark-done` | Mark decisions as complete after merge |
+| post-rewrite | `sqlew mark-done` | Mark decisions as complete after rebase |
+
+## Configuration
+
+Generated configuration in `.claude/settings.local.json`:
+
+```json
+{
+  "hooks": {
+    "PreToolUse": [
+      {
+        "matcher": "Task",
+        "hooks": [
+          {
+            "type": "command",
+            "command": "sqlew suggest"
+          }
+        ]
+      }
+    ],
+    "PostToolUse": [
+      {
+        "matcher": "Edit|Write",
+        "hooks": [
+          {
+            "type": "command",
+            "command": "sqlew save"
+          }
+        ]
+      },
+      {
+        "matcher": "TodoWrite",
+        "hooks": [
+          {
+            "type": "command",
+            "command": "sqlew check-completion"
+          }
+        ]
+      }
+    ]
+  }
+}
+```
+
+## Queue File Format
+
+`.sqlew/queue/pending.json`:
+
+```json
+{
+  "items": [
+    {
+      "type": "decision",
+      "action": "update",
+      "key": "plan/my-feature",
+      "timestamp": 1703404800000,
+      "data": {
+        "value": "in_progress",
+        "layer": "planning"
+      }
+    }
+  ]
+}
+```
+
+## Troubleshooting
+
+### Hooks not triggering
+
+1. Check `.claude/settings.local.json` exists
+2. Verify hook configuration format
+3. Restart Claude Code to reload hooks
+
+### Queue not processing
+
+1. Ensure MCP server is running
+2. Check `.sqlew/queue/pending.json` for items
+3. Verify QueueWatcher is active (check debug logs)
+
+### Debug logging
+
+Enable debug logging in `.sqlew/config.toml`:
+
+```toml
+[debug]
+log_path = ".sqlew/debug.log"
+log_level = "debug"
+```
+
+## Version History
+
+- **v4.1.0**: Initial Claude Code Hooks integration with File Queue Architecture