Skip to content

QUICKSTART.md

Latest commit

 

History

History
110 lines (77 loc) · 2.56 KB

QUICKSTART.md

File metadata and controls

110 lines (77 loc) · 2.56 KB

SDP Quick Start

Get from zero to your first feature in 5 minutes.

1. Install

Full project (prompts + hooks + optional CLI): default install

# Into your project (auto-detects Claude Code, Cursor, OpenCode)
curl -sSL https://raw.githubusercontent.com/fall-out-bug/sdp/main/install.sh | sh

Binary only (CLI to ~/.local/bin):

curl -sSL https://raw.githubusercontent.com/fall-out-bug/sdp/main/install.sh | sh -s -- --binary-only

Or: submodule

git submodule add https://github.com/fall-out-bug/sdp.git sdp

Skills load from sdp/.claude/skills/, sdp/.cursor/skills/, or sdp/.opencode/.

2. Initialize

sdp init --auto    # Safe defaults, non-interactive
# or
sdp init --guided  # Interactive wizard

Creates .sdp/config.yml, guard rules, and IDE integration.

If you get "unknown flag: --auto", upgrade the CLI: curl -sSL https://raw.githubusercontent.com/fall-out-bug/sdp/main/install.sh | sh -s -- --binary-only

3. Create a Feature

Discovery (planning):

@feature "OpenCode plugin for beads visualization"

This runs:

  • @idea — Requirements gathering
  • @design — Workstream decomposition into docs/workstreams/backlog/00-XXX-YY.md

Delivery (implementation):

@oneshot <feature-id>      # Autonomous: build all workstreams
@review <feature-id>       # Multi-agent quality review
@deploy <feature-id>      # Merge to main

Or step-by-step:

@build 00-001-01   # Single workstream with TDD
@build 00-001-02
@review <feature-id>
@deploy <feature-id>

4. Verify

sdp verify 00-001-01   # Check workstream completion
sdp status             # Project state
sdp next               # Recommended next action
sdp log show           # Evidence log

For a guided dry run of this flow:

sdp demo

5. Optional: Beads

Task tracking for multi-session work:

brew tap beads-dev/tap && brew install beads
bd ready               # Find available tasks
bd create --title="..." # Create task
bd close <id>          # Close task

Flow Summary

@feature "X"  →  @oneshot <feature-id>  →  @review <feature-id>  →  @deploy <feature-id>
     │                  │                │                │
     ▼                  ▼                ▼                ▼
  Workstreams      Execute WS       APPROVED?         Merge PR

Done = @review APPROVED + @deploy completed.

Next