panopticon-cli 0.4.6 → 0.4.7

package/skills/beads/resources/TROUBLESHOOTING.md

@@ -0,0 +1,489 @@
+# Troubleshooting Guide
+
+Common issues encountered when using bd and how to resolve them.
+
+## Interface-Specific Troubleshooting
+
+**MCP tools (local environment):**
+- MCP tools require bd daemon running
+- Check daemon status: `bd daemon --status` (CLI)
+- If MCP tools fail, verify daemon is running and restart if needed
+- MCP tools automatically use daemon mode (no --no-daemon option)
+
+**CLI (web environment or local):**
+- CLI can use daemon mode (default) or direct mode (--no-daemon)
+- Direct mode has 3-5 second sync delay
+- Web environment: Install via `npm install -g @beads/cli`
+- Web environment: Initialize via `bd init <prefix>` before first use
+
+**Most issues below apply to both interfaces** - the underlying database and daemon behavior is the same.
+
+## Contents
+
+- [Dependencies Not Persisting](#dependencies-not-persisting)
+- [Status Updates Not Visible](#status-updates-not-visible)
+- [Daemon Won't Start](#daemon-wont-start)
+- [Database Errors on Cloud Storage](#database-errors-on-cloud-storage)
+- [JSONL File Not Created](#jsonl-file-not-created)
+- [Version Requirements](#version-requirements)
+
+---
+
+## Dependencies Not Persisting
+
+### Symptom
+```bash
+bd dep add issue-2 issue-1 --type blocks
+# Reports: ✓ Added dependency
+bd show issue-2
+# Shows: No dependencies listed
+```
+
+### Root Cause (Fixed in v0.15.0+)
+This was a **bug in bd** (GitHub issue #101) where the daemon ignored dependencies during issue creation. **Fixed in bd v0.15.0** (Oct 21, 2025).
+
+### Resolution
+
+**1. Check your bd version:**
+```bash
+bd version
+```
+
+**2. If version < 0.15.0, update bd:**
+```bash
+# Via Homebrew (macOS/Linux)
+brew upgrade bd
+
+# Via go install
+go install github.com/steveyegge/beads/cmd/bd@latest
+
+# Via package manager
+# See https://github.com/steveyegge/beads#installing
+```
+
+**3. Restart daemon after upgrade:**
+```bash
+pkill -f "bd daemon"  # Kill old daemon
+bd daemon             # Start new daemon with fix
+```
+
+**4. Test dependency creation:**
+```bash
+bd create "Test A" -t task
+bd create "Test B" -t task
+bd dep add <B-id> <A-id> --type blocks
+bd show <B-id>
+# Should show: "Depends on (1): → <A-id>"
+```
+
+### Still Not Working?
+
+If dependencies still don't persist after updating:
+
+1. **Check daemon is running:**
+   ```bash
+   ps aux | grep "bd daemon"
+   ```
+
+2. **Try without --no-daemon flag:**
+   ```bash
+   # Instead of: bd --no-daemon dep add ...
+   # Use: bd dep add ...  (let daemon handle it)
+   ```
+
+3. **Check JSONL file:**
+   ```bash
+   cat .beads/issues.jsonl | jq '.dependencies'
+   # Should show dependency array
+   ```
+
+4. **Report to beads GitHub** with:
+   - `bd version` output
+   - Operating system
+   - Reproducible test case
+
+---
+
+## Status Updates Not Visible
+
+### Symptom
+```bash
+bd --no-daemon update issue-1 --status in_progress
+# Reports: ✓ Updated issue: issue-1
+bd show issue-1
+# Shows: Status: open (not in_progress!)
+```
+
+### Root Cause
+This is **expected behavior**, not a bug. Understanding requires knowing bd's architecture:
+
+**BD Architecture:**
+- **JSONL files** (`.beads/issues.jsonl`): Human-readable export format
+- **SQLite database** (`.beads/*.db`): Source of truth for queries
+- **Daemon**: Syncs JSONL ↔ SQLite every 5 minutes
+
+**What `--no-daemon` actually does:**
+- **Writes**: Go directly to JSONL file
+- **Reads**: Still come from SQLite database
+- **Sync delay**: Daemon imports JSONL → SQLite periodically
+
+### Resolution
+
+**Option 1: Use daemon mode (recommended)**
+```bash
+# Don't use --no-daemon for CRUD operations
+bd update issue-1 --status in_progress
+bd show issue-1
+# ✓ Status reflects immediately
+```
+
+**Option 2: Wait for sync (if using --no-daemon)**
+```bash
+bd --no-daemon update issue-1 --status in_progress
+# Wait 3-5 seconds for daemon to sync
+sleep 5
+bd show issue-1
+# ✓ Status should reflect now
+```
+
+**Option 3: Manual sync trigger**
+```bash
+bd --no-daemon update issue-1 --status in_progress
+# Trigger sync by exporting/importing
+bd export > /dev/null 2>&1  # Forces sync
+bd show issue-1
+```
+
+### When to Use `--no-daemon`
+
+**Use --no-daemon for:**
+- Batch import scripts (performance)
+- CI/CD environments (no persistent daemon)
+- Testing/debugging
+
+**Don't use --no-daemon for:**
+- Interactive development
+- Real-time status checks
+- When you need immediate query results
+
+---
+
+## Daemon Won't Start
+
+### Symptom
+```bash
+bd daemon
+# Error: not in a git repository
+# Hint: run 'git init' to initialize a repository
+```
+
+### Root Cause
+bd daemon requires a **git repository** because it uses git for:
+- Syncing issues to git remote (optional)
+- Version control of `.beads/*.jsonl` files
+- Commit history of issue changes
+
+### Resolution
+
+**Initialize git repository:**
+```bash
+# In your project directory
+git init
+bd daemon
+# ✓ Daemon should start now
+```
+
+**Prevent git remote operations:**
+```bash
+# If you don't want daemon to pull from remote
+bd daemon --global=false
+```
+
+**Flags:**
+- `--global=false`: Don't sync with git remote
+- `--interval=10m`: Custom sync interval (default: 5m)
+- `--auto-commit=true`: Auto-commit JSONL changes
+
+---
+
+## Database Errors on Cloud Storage
+
+### Symptom
+```bash
+# In directory: /Users/name/Google Drive/...
+bd init myproject
+# Error: disk I/O error (522)
+# OR: Error: database is locked
+```
+
+### Root Cause
+**SQLite incompatibility with cloud sync filesystems.**
+
+Cloud services (Google Drive, Dropbox, OneDrive, iCloud) don't support:
+- POSIX file locking (required by SQLite)
+- Consistent file handles across sync operations
+- Atomic write operations
+
+This is a **known SQLite limitation**, not a bd bug.
+
+### Resolution
+
+**Move bd database to local filesystem:**
+
+```bash
+# Wrong location (cloud sync)
+~/Google Drive/My Work/project/.beads/  # ✗ Will fail
+
+# Correct location (local disk)
+~/Repos/project/.beads/                 # ✓ Works reliably
+~/Projects/project/.beads/              # ✓ Works reliably
+```
+
+**Migration steps:**
+
+1. **Move project to local disk:**
+   ```bash
+   mv ~/Google\ Drive/project ~/Repos/project
+   cd ~/Repos/project
+   ```
+
+2. **Re-initialize bd (if needed):**
+   ```bash
+   bd init myproject
+   ```
+
+3. **Import existing issues (if you had JSONL export):**
+   ```bash
+   bd import < issues-backup.jsonl
+   ```
+
+**Alternative: Use global `~/.beads/` database**
+
+If you must keep work on cloud storage:
+```bash
+# Don't initialize bd in cloud-synced directory
+# Use global database instead
+cd ~/Google\ Drive/project
+bd create "My task"
+# Uses ~/.beads/default.db (on local disk)
+```
+
+**Workaround limitations:**
+- No per-project database isolation
+- All projects share same issue prefix
+- Manual tracking of which issues belong to which project
+
+**Recommendation:** Keep code/projects on local disk, sync final deliverables to cloud.
+
+---
+
+## JSONL File Not Created
+
+### Symptom
+```bash
+bd init myproject
+bd --no-daemon create "Test" -t task
+ls .beads/
+# Only shows: .gitignore, myproject.db
+# Missing: issues.jsonl
+```
+
+### Root Cause
+**JSONL initialization coupling.** The `issues.jsonl` file is created by daemon on first startup, not by `bd init`.
+
+### Resolution
+
+**Start daemon once to initialize JSONL:**
+```bash
+bd daemon --global=false &
+# Wait for initialization
+sleep 2
+
+# Now JSONL file exists
+ls .beads/issues.jsonl
+# ✓ File created
+
+# Subsequent --no-daemon operations work
+bd --no-daemon create "Task 1" -t task
+cat .beads/issues.jsonl
+# ✓ Shows task data
+```
+
+**Why this matters:**
+- Daemon owns the JSONL export format
+- First daemon run creates empty JSONL skeleton
+- `--no-daemon` operations assume JSONL exists
+
+**Pattern for batch scripts:**
+```bash
+#!/bin/bash
+# Batch import script
+
+bd init myproject
+bd daemon --global=false &  # Start daemon
+sleep 3                     # Wait for initialization
+
+# Now safe to use --no-daemon for performance
+for item in "${items[@]}"; do
+    bd --no-daemon create "$item" -t feature
+done
+
+# Daemon syncs JSONL → SQLite in background
+sleep 5  # Wait for final sync
+
+# Query results
+bd stats
+```
+
+---
+
+## Version Requirements
+
+### Minimum Version for Dependency Persistence
+
+**Issue:** Dependencies created but don't appear in `bd show` or dependency tree.
+
+**Fix:** Upgrade to **bd v0.15.0+** (released Oct 2025)
+
+**Check version:**
+```bash
+bd version
+# Should show: bd version 0.15.0 or higher
+```
+
+**If using MCP plugin:**
+```bash
+# Update Claude Code beads plugin
+claude plugin update beads
+```
+
+### Breaking Changes
+
+**v0.15.0:**
+- MCP parameter names changed from `from_id/to_id` to `issue_id/depends_on_id`
+- Dependency creation now persists correctly in daemon mode
+
+**v0.14.0:**
+- Daemon architecture changes
+- Auto-sync JSONL behavior introduced
+
+---
+
+## MCP-Specific Issues
+
+### Dependencies Created Backwards
+
+**Symptom:**
+Using MCP tools, dependencies end up reversed from intended.
+
+**Example:**
+```python
+# Want: "task-2 depends on task-1" (task-1 blocks task-2)
+beads_add_dependency(issue_id="task-1", depends_on_id="task-2")
+# Wrong! This makes task-1 depend on task-2
+```
+
+**Root Cause:**
+Parameter confusion between old (`from_id/to_id`) and new (`issue_id/depends_on_id`) names.
+
+**Resolution:**
+
+**Correct MCP usage (bd v0.15.0+):**
+```python
+# Correct: task-2 depends on task-1
+beads_add_dependency(
+    issue_id="task-2",        # Issue that has dependency
+    depends_on_id="task-1",   # Issue that must complete first
+    dep_type="blocks"
+)
+```
+
+**Mnemonic:**
+- `issue_id`: The issue that **waits**
+- `depends_on_id`: The issue that **must finish first**
+
+**Equivalent CLI:**
+```bash
+bd dep add task-2 task-1 --type blocks
+# Meaning: task-2 depends on task-1
+```
+
+**Verify dependency direction:**
+```bash
+bd show task-2
+# Should show: "Depends on: task-1"
+# Not the other way around
+```
+
+---
+
+## Getting Help
+
+### Debug Checklist
+
+Before reporting issues, collect this information:
+
+```bash
+# 1. Version
+bd version
+
+# 2. Daemon status
+ps aux | grep "bd daemon"
+
+# 3. Database location
+echo $PWD/.beads/*.db
+ls -la .beads/
+
+# 4. Git status
+git status
+git log --oneline -1
+
+# 5. JSONL contents (for dependency issues)
+cat .beads/issues.jsonl | jq '.' | head -50
+```
+
+### Report to beads GitHub
+
+If problems persist:
+
+1. **Check existing issues:** https://github.com/steveyegge/beads/issues
+2. **Create new issue** with:
+   - bd version (`bd version`)
+   - Operating system
+   - Debug checklist output (above)
+   - Minimal reproducible example
+   - Expected vs actual behavior
+
+### Claude Code Skill Issues
+
+If the **bd-issue-tracking skill** provides incorrect guidance:
+
+1. **Check skill version:**
+   ```bash
+   ls -la ~/.claude/skills/bd-issue-tracking/
+   head -20 ~/.claude/skills/bd-issue-tracking/SKILL.md
+   ```
+
+2. **Report via Claude Code feedback** or user's GitHub
+
+---
+
+## Quick Reference: Common Fixes
+
+| Problem | Quick Fix |
+|---------|-----------|
+| Dependencies not saving | Upgrade to bd v0.15.0+ |
+| Status updates lag | Use daemon mode (not `--no-daemon`) |
+| Daemon won't start | Run `git init` first |
+| Database errors on Google Drive | Move to local filesystem |
+| JSONL file missing | Start daemon once: `bd daemon &` |
+| Dependencies backwards (MCP) | Update to v0.15.0+, use `issue_id/depends_on_id` correctly |
+
+---
+
+## Related Documentation
+
+- [CLI Reference](CLI_REFERENCE.md) - Complete command documentation
+- [Dependencies Guide](DEPENDENCIES.md) - Understanding dependency types
+- [Workflows](WORKFLOWS.md) - Step-by-step workflow guides
+- [beads GitHub](https://github.com/steveyegge/beads) - Official documentation