* fix(init): wire git origin as Dolt remote Default bd init now treats a git origin as the Dolt remote, persists sync.remote, and still skips synthesis in --stealth. JSONL auto-export/import paths now warn or skip based on sync.remote so exports do not masquerade as cross-machine sync. Docs and generated agent/CLI references now state that Dolt is canonical, refs/dolt/data is the sync channel, and .beads/issues.jsonl is export/interchange/backup only. _codex-gpt-5-xhigh on behalf of maphew_ * test: keep embedded command stderr out of parsed stdout Embedded command tests parse IDs and JSON from command output. The new auto-export warnings correctly go to stderr, but several tests used CombinedOutput and treated warnings as stdout, which broke CI shards that parse issue IDs or JSON lists. Capture stdout separately on success while preserving combined output for error diagnostics.\n\n_codex-gpt-5-medium on behalf of CI Bot_ --------- Co-authored-by: CI Bot <ci@beads.test>
95 lines
5.3 KiB
Go
95 lines
5.3 KiB
Go
package main
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/spf13/cobra"
|
|
"github.com/steveyegge/beads/internal/ui"
|
|
)
|
|
|
|
var quickstartCmd = &cobra.Command{
|
|
Use: "quickstart",
|
|
GroupID: "setup",
|
|
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) {
|
|
fmt.Printf("\n%s\n\n", ui.RenderBold("bd - Dependency-Aware Issue Tracker"))
|
|
fmt.Printf("Issues chained together like beads.\n\n")
|
|
|
|
fmt.Printf("%s\n", ui.RenderBold("GETTING STARTED"))
|
|
fmt.Printf(" %s Initialize bd in your project (embedded Dolt, no server needed)\n", ui.RenderAccent("bd init"))
|
|
fmt.Printf(" Creates .beads/ directory with project-specific Dolt 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", ui.RenderAccent("bd init --prefix api"))
|
|
fmt.Printf(" Issues will be named: api-<hash> (e.g., api-a3f2dd)\n\n")
|
|
|
|
fmt.Printf(" %s Initialize with external Dolt server (multi-writer)\n", ui.RenderAccent("bd init --server"))
|
|
fmt.Printf(" Connects to a running dolt sql-server for concurrent access\n\n")
|
|
|
|
fmt.Printf("%s\n", ui.RenderBold("CREATING ISSUES"))
|
|
fmt.Printf(" %s\n", ui.RenderAccent("bd create \"Fix login bug\""))
|
|
fmt.Printf(" %s\n", ui.RenderAccent("bd create \"Add auth\" -p 0 -t feature"))
|
|
fmt.Printf(" %s\n\n", ui.RenderAccent("bd create \"Write tests\" -d \"Unit tests for auth\" --assignee alice"))
|
|
|
|
fmt.Printf("%s\n", ui.RenderBold("VIEWING ISSUES"))
|
|
fmt.Printf(" %s List all issues\n", ui.RenderAccent("bd list"))
|
|
fmt.Printf(" %s List by status\n", ui.RenderAccent("bd list --status open"))
|
|
fmt.Printf(" %s List by priority (0-4, 0=highest)\n", ui.RenderAccent("bd list --priority 0"))
|
|
fmt.Printf(" %s Show issue details\n\n", ui.RenderAccent("bd show bd-1"))
|
|
|
|
fmt.Printf("%s\n", ui.RenderBold("MANAGING DEPENDENCIES"))
|
|
fmt.Printf(" %s Add dependency (bd-2 blocks bd-1)\n", ui.RenderAccent("bd dep add bd-1 bd-2"))
|
|
fmt.Printf(" %s Visualize dependency tree\n", ui.RenderAccent("bd dep tree bd-1"))
|
|
fmt.Printf(" %s Detect circular dependencies\n\n", ui.RenderAccent("bd dep cycles"))
|
|
|
|
fmt.Printf("%s\n", ui.RenderBold("DEPENDENCY TYPES"))
|
|
fmt.Printf(" %s Task B must complete before task A\n", ui.RenderWarn("blocks"))
|
|
fmt.Printf(" %s Soft connection, doesn't block progress\n", ui.RenderWarn("related"))
|
|
fmt.Printf(" %s Epic/subtask hierarchical relationship\n", ui.RenderWarn("parent-child"))
|
|
fmt.Printf(" %s Auto-created when AI discovers related work\n\n", ui.RenderWarn("discovered-from"))
|
|
|
|
fmt.Printf("%s\n", ui.RenderBold("READY WORK"))
|
|
fmt.Printf(" %s Show issues ready to work on\n", ui.RenderAccent("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", ui.RenderBold("UPDATING ISSUES"))
|
|
fmt.Printf(" %s\n", ui.RenderAccent("bd update bd-1 --claim"))
|
|
fmt.Printf(" %s\n", ui.RenderAccent("bd update bd-1 --priority 0"))
|
|
fmt.Printf(" %s\n\n", ui.RenderAccent("bd update bd-1 --assignee bob"))
|
|
|
|
fmt.Printf("%s\n", ui.RenderBold("CLOSING ISSUES"))
|
|
fmt.Printf(" %s\n", ui.RenderAccent("bd close bd-1"))
|
|
fmt.Printf(" %s\n\n", ui.RenderAccent("bd close bd-2 bd-3 --reason \"Fixed in PR #42\""))
|
|
|
|
fmt.Printf("%s\n", ui.RenderBold("STORAGE"))
|
|
fmt.Printf(" bd uses Dolt, a version-controlled SQL database:\n")
|
|
fmt.Printf(" %s Embedded mode (default): in-process, zero config\n", ui.RenderPass("●"))
|
|
fmt.Printf(" Data stored in %s\n", ui.RenderAccent(".beads/embeddeddolt/"))
|
|
fmt.Printf(" %s Server mode (%s): multi-writer via dolt sql-server\n", ui.RenderPass("●"), ui.RenderAccent("bd init --server"))
|
|
fmt.Printf(" Data managed by external server\n\n")
|
|
|
|
fmt.Printf("%s\n", ui.RenderBold("SYNC"))
|
|
fmt.Printf(" Share issues with your team using Dolt remotes:\n")
|
|
fmt.Printf(" %s Verify remote (bd init auto-wires git origin when present)\n", ui.RenderAccent("bd dolt remote list"))
|
|
fmt.Printf(" %s Add remote if needed\n", ui.RenderAccent("bd dolt remote add origin git+ssh://git@github.com/org/repo.git"))
|
|
fmt.Printf(" %s Push issues\n", ui.RenderAccent("bd dolt push"))
|
|
fmt.Printf(" %s Pull from teammates\n", ui.RenderAccent("bd dolt pull"))
|
|
fmt.Printf(" Dolt handles sync natively with cell-level merge; JSONL is export, not sync\n\n")
|
|
|
|
fmt.Printf("%s\n", ui.RenderBold("AGENT INTEGRATION"))
|
|
fmt.Printf(" bd is designed for AI-supervised workflows:\n")
|
|
fmt.Printf(" %s Agents create issues when discovering new work\n", ui.RenderPass("●"))
|
|
fmt.Printf(" %s %s shows unblocked work ready to claim\n", ui.RenderPass("●"), ui.RenderAccent("bd ready"))
|
|
fmt.Printf(" %s Use %s flags for programmatic parsing\n", ui.RenderPass("●"), ui.RenderAccent("--json"))
|
|
fmt.Printf(" %s Dependencies prevent agents from duplicating effort\n\n", ui.RenderPass("●"))
|
|
|
|
fmt.Printf("%s\n", ui.RenderPass("Ready to start!"))
|
|
fmt.Printf("Run %s to create your first issue.\n\n", ui.RenderAccent("bd create \"My first issue\""))
|
|
},
|
|
}
|
|
|
|
func init() {
|
|
rootCmd.AddCommand(quickstartCmd)
|
|
}
|