llms.txt

# spec-superflow

## Overview
spec-superflow is a self-contained workflow integration plugin for Claude Code, Cursor, OpenAI Codex CLI/App, GitHub Copilot CLI, Gemini CLI, OpenCode, WorkBuddy, and Trae. It merges spec-driven planning artifacts (proposal, specs, design, tasks) with disciplined execution guardrails (TDD, review gates, controlled handoff) into one unified workflow.

Current version: v0.8.9.

## Key Documents
- README.md: Chinese homepage with full usage guide and FAQ
- docs/README_en.md: English documentation
- INSTALL.md: Multi-platform installation guide
- docs/state-machine.md: Workflow state machine (exploring -> specifying -> bridging -> approved-for-build -> executing -> closing)
- docs/artifact-contract.md: Artifact mapping from planning to execution contract
- docs/decision-points.md: Standard decision-point protocol
- CHANGELOG.md: Version history
- CONTRIBUTING.md: Contribution guidelines

## Core Skills (in skills/)
- workflow-start: Entry point, content-level state detection, 8-state routing, blocks illegal transitions
- need-explorer: Clarifies intent, scope, constraints, and success criteria
- spec-writer: Generates proposal, specs, design, and tasks with Schema validation
- contract-builder: Parses 4 artifacts and compresses into execution-contract.md
- build-executor: Enforces TDD, SDD subagent execution, and Review Gates
- bug-investigator: 4-phase root cause analysis, escalates after repeated failures
- code-reviewer: Structured review with Critical / Important / Minor severity
- release-archivist: Verification-before-completion, archiving, risk summary
- spec-merger: Merges delta specs into main specs with conflict detection

## Templates (in templates/)
- proposal.md: Change proposal template
- spec.md: Capability specification template
- design.md: Technical design template
- tasks.md: Implementation tasks template
- execution-contract.md: Bridge artifact template

## Examples (in docs/examples/)
- add-dark-mode: New UI feature example (dark mode)
- refactor-auth-boundary: Brownfield backend refactor example (auth layer)

## Installation
See INSTALL.md for platform-specific instructions. Quick install for Claude Code:
```
/plugin marketplace add MageByte-Zero/spec-superflow
/plugin install spec-superflow@spec-superflow
```

Cursor: `npx spec-superflow@latest install-cursor`
WorkBuddy: `npx spec-superflow@latest install-workbuddy`

## Usage
Start from workflow-start. The workflow inspects current artifacts and routes to the correct stage automatically.