msd-core/docs

GSD Core documentation

Documentation is organised into four quadrants: tutorials help you learn by doing, how-to guides solve specific tasks, reference states authoritative facts, and explanation explores concepts and design decisions.

Language versions: English · Português (pt-BR) · 日本語 · 简体中文

---

Tutorials

• Your first project — install to first shipped phase, one guaranteed path
• Onboarding an existing codebase — bring GSD Core to a brownfield repo

---

How-to guides

• Install on your runtime — runtime-specific install steps for all 16 supported runtimes
• Install a minimal GSD and add skills later — install only the core skills, then grow the surface with profiles and /gsd:surface
• Discuss a phase — capture implementation decisions before planning begins
• Plan a phase — run research, decompose work, and verify plan quality
• Execute a phase — run plans in parallel waves with fresh-context subagents
• Verify and ship — walk through completed work, diagnose failures, and create the PR
• Run phases autonomously — use autonomous mode for unattended phase execution
• Handle quick and fast tasks — use /gsd-quick and /gsd-fast for ad-hoc work outside the phase loop
• Configure model profiles — switch between quality, balanced, and budget model tiers
• Set up cross-AI review — configure a second AI to review code produced by the primary agent
• Work in parallel with workstreams — run independent lines of work simultaneously using workstreams
• Isolate work with workspaces — use workspaces to sandbox experimental or risky changes
• Debug a failed execution — diagnose and recover from broken or incomplete phase execution
• Spike and sketch — use /gsd-spike and /gsd-sketch for exploratory work before committing to a plan
• Design a UI phase — use the UI phase loop for frontend and visual work
• Drive GSD from a tracker issue — start a phase from a GitHub, Linear, or Jira issue
• Migrate from GSD 2 — upgrade an existing GSD 2 project to GSD Core
• Update GSD — re-run the installer to pick up the latest release
• Clean up get-shit-done-cc — remove leftover old-package artifacts that cause a spurious ⬆ /gsd:update indicator after migrating to @opengsd/gsd-core
• Fix the worktree base-mismatch (exit 42) error — resolve the branch-divergence condition that halts parallel phase execution
• Recover and troubleshoot — fix common problems, rebuild context, and uninstall

---

Reference

• Commands — every command with flags and examples
• Configuration — full config schema, model profiles, git branching strategies
• CLI tools — gsd-tools.cjs programmatic API for workflows and agents
• Features — complete feature index
• Inventory — installed skills and surface map
• STATE.md schema — field-by-field reference for .planning/STATE.md
• CONTEXT.md schema — field-by-field reference for .planning/phases/<N>/CONTEXT.md
• PLAN.md schema — field-by-field reference for .planning/phases/<N>/PLAN.md
• Planning artifacts — all .planning/ files and their roles

---

Explanation

• Context engineering — how context rot forms and how GSD Core prevents it
• The phase loop — design rationale for the Discuss → Plan → Execute → Verify → Ship cycle
• Multi-agent orchestration — how subagents are spawned, scoped, and coordinated
• Security model — trust boundaries, permissions, and safe automation
• Architecture — system architecture, agent model, and data flow
• Discuss modes — assumptions mode vs interview mode for /gsd-discuss-phase
• Context monitoring — context window monitoring hook architecture
• Issue-driven orchestration — recipe for driving GSD from a tracker issue using existing primitives

---

Related

• Root README — landing page, quickstart, and documentation overview
• Changelog — release history