Implement JSONL export/import and shift to text-first architecture

This is a fundamental architectural shift from binary SQLite to JSONL as
the source of truth for git workflows.

## New Features

- `bd export --format=jsonl` - Export issues to JSON Lines format
- `bd import` - Import issues from JSONL (create new, update existing)
- `--skip-existing` flag for import to only create new issues

## Architecture Change

**Before:** Binary SQLite database committed to git
**After:** JSONL text files as source of truth, SQLite as ephemeral cache

Benefits:
- Git-friendly text format with clean diffs
- AI-resolvable merge conflicts (append-only is 95% conflict-free)
- Human-readable issue tracking in git
- No binary merge conflicts

## Documentation

- Updated README with JSONL-first workflow and git hooks
- Added TEXT_FORMATS.md analyzing JSONL vs CSV vs binary
- Updated GIT_WORKFLOW.md with historical context
- .gitignore now excludes *.db, includes .beads/*.jsonl

## Implementation Details

- Export sorts issues by ID for consistent diffs
- Import handles both creates and updates atomically
- Proper handling of pointer fields (EstimatedMinutes)
- All tests passing

## Breaking Changes

- Database files (*.db) should now be gitignored
- Use export/import workflow for git collaboration
- Git hooks recommended for automation

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Steve Yegge
2025-10-12 01:17:50 -07:00
parent 9105059843
commit 15afb5ad17
25 changed files with 3322 additions and 129 deletions

94
cmd/bd/quickstart.go Normal file
View File

@@ -0,0 +1,94 @@
package main
import (
"fmt"
"github.com/fatih/color"
"github.com/spf13/cobra"
)
var quickstartCmd = &cobra.Command{
Use: "quickstart",
Short: "Quick start guide for bd",
Long: `Display a quick start guide showing common bd workflows and patterns.`,
Run: func(cmd *cobra.Command, args []string) {
cyan := color.New(color.FgCyan).SprintFunc()
green := color.New(color.FgGreen).SprintFunc()
yellow := color.New(color.FgYellow).SprintFunc()
bold := color.New(color.Bold).SprintFunc()
fmt.Printf("\n%s\n\n", bold("bd - Dependency-Aware Issue Tracker"))
fmt.Printf("Issues chained together like beads.\n\n")
fmt.Printf("%s\n", bold("GETTING STARTED"))
fmt.Printf(" %s Initialize bd in your project\n", cyan("bd init"))
fmt.Printf(" Creates .beads/ directory with project-specific database\n")
fmt.Printf(" Auto-detects prefix from directory name (e.g., myapp-1, myapp-2)\n\n")
fmt.Printf(" %s Initialize with custom prefix\n", cyan("bd init --prefix api"))
fmt.Printf(" Issues will be named: api-1, api-2, ...\n\n")
fmt.Printf("%s\n", bold("CREATING ISSUES"))
fmt.Printf(" %s\n", cyan("bd create \"Fix login bug\""))
fmt.Printf(" %s\n", cyan("bd create \"Add auth\" -p 0 -t feature"))
fmt.Printf(" %s\n\n", cyan("bd create \"Write tests\" -d \"Unit tests for auth\" --assignee alice"))
fmt.Printf("%s\n", bold("VIEWING ISSUES"))
fmt.Printf(" %s List all issues\n", cyan("bd list"))
fmt.Printf(" %s List by status\n", cyan("bd list --status open"))
fmt.Printf(" %s List by priority (0-4, 0=highest)\n", cyan("bd list --priority 0"))
fmt.Printf(" %s Show issue details\n\n", cyan("bd show bd-1"))
fmt.Printf("%s\n", bold("MANAGING DEPENDENCIES"))
fmt.Printf(" %s Add dependency (bd-2 blocks bd-1)\n", cyan("bd dep add bd-1 bd-2"))
fmt.Printf(" %s Visualize dependency tree\n", cyan("bd dep tree bd-1"))
fmt.Printf(" %s Detect circular dependencies\n\n", cyan("bd dep cycles"))
fmt.Printf("%s\n", bold("DEPENDENCY TYPES"))
fmt.Printf(" %s Task B must complete before task A\n", yellow("blocks"))
fmt.Printf(" %s Soft connection, doesn't block progress\n", yellow("related"))
fmt.Printf(" %s Epic/subtask hierarchical relationship\n", yellow("parent-child"))
fmt.Printf(" %s Auto-created when AI discovers related work\n\n", yellow("discovered-from"))
fmt.Printf("%s\n", bold("READY WORK"))
fmt.Printf(" %s Show issues ready to work on\n", cyan("bd ready"))
fmt.Printf(" Ready = status is 'open' AND no blocking dependencies\n")
fmt.Printf(" Perfect for agents to claim next work!\n\n")
fmt.Printf("%s\n", bold("UPDATING ISSUES"))
fmt.Printf(" %s\n", cyan("bd update bd-1 --status in_progress"))
fmt.Printf(" %s\n", cyan("bd update bd-1 --priority 0"))
fmt.Printf(" %s\n\n", cyan("bd update bd-1 --assignee bob"))
fmt.Printf("%s\n", bold("CLOSING ISSUES"))
fmt.Printf(" %s\n", cyan("bd close bd-1"))
fmt.Printf(" %s\n\n", cyan("bd close bd-2 bd-3 --reason \"Fixed in PR #42\""))
fmt.Printf("%s\n", bold("DATABASE LOCATION"))
fmt.Printf(" bd automatically discovers your database:\n")
fmt.Printf(" 1. %s flag\n", cyan("--db /path/to/db.db"))
fmt.Printf(" 2. %s environment variable\n", cyan("$BEADS_DB"))
fmt.Printf(" 3. %s in current directory or ancestors\n", cyan(".beads/*.db"))
fmt.Printf(" 4. %s as fallback\n\n", cyan("~/.beads/default.db"))
fmt.Printf("%s\n", bold("AGENT INTEGRATION"))
fmt.Printf(" bd is designed for AI-supervised workflows:\n")
fmt.Printf(" • Agents create issues when discovering new work\n")
fmt.Printf(" • %s shows unblocked work ready to claim\n", cyan("bd ready"))
fmt.Printf(" • Use %s flags for programmatic parsing\n", cyan("--json"))
fmt.Printf(" • Dependencies prevent agents from duplicating effort\n\n")
fmt.Printf("%s\n", bold("DATABASE EXTENSION"))
fmt.Printf(" Applications can extend bd's SQLite database:\n")
fmt.Printf(" • Add your own tables (e.g., %s)\n", cyan("myapp_executions"))
fmt.Printf(" • Join with %s table for powerful queries\n", cyan("issues"))
fmt.Printf(" • See %s for integration patterns\n\n", cyan("EXTENDING.md"))
fmt.Printf("%s\n", green("Ready to start!"))
fmt.Printf("Run %s to create your first issue.\n\n", cyan("bd create \"My first issue\""))
},
}
func init() {
rootCmd.AddCommand(quickstartCmd)
}