Skip to content

Improves upon Github's speckit workflow with orchestration and better project initiation.

License

Notifications You must be signed in to change notification settings

wiseyoda/specflow

Repository files navigation

SpecFlow

Spec-driven development framework for Claude Code
Structure requirements. Generate specs. Orchestrate implementation.

Test Suite License Platform


Why SpecFlow?

Building software with AI assistants works best with structure. SpecFlow provides:

  • Guided requirements gathering - Never miss critical decisions
  • Consistent artifacts - Specs, plans, and tasks that work together
  • Automated workflows - From requirements to merged PR in one command
  • State persistence - Resume anywhere, track progress across sessions
  • Quality gates - Validation at every stage

Table of Contents


Install

git clone https://github.com/wiseyoda/claude-specflow-orchestration.git
cd claude-specflow-orchestration
./install.sh

Add to your shell profile (~/.bashrc or ~/.zshrc):

export PATH="$HOME/.claude/specflow-system/bin:$PATH"

Verify:

specflow --version
specflow status

Quick Start

1. Create project structure:

specflow init                    # Creates .specflow/, .specify/, ROADMAP.md, etc.

2. Run discovery interview in Claude Code:

/flow.init                       # AI-guided requirements gathering

3. Start development:

/flow.orchestrate                # Full automated workflow

SpecFlow guides you through design → analyze → implement → verify.


How It Works

flowchart TD
    A["specflow init"] --> B["/flow.init"]
    B --> C["/flow.orchestrate"]
    C --> D["design → analyze → implement → verify"]
    D --> E["/flow.merge"]
    E --> F["Next Phase"]
    F --> C
Loading

SpecFlow manages the full development lifecycle:

Stage What Happens
Scaffold specflow init creates project structure (.specflow/, .specify/, ROADMAP.md)
Discovery /flow.init runs AI-guided interview to capture requirements
Orchestrate Automated workflow: design → analyze → implement → verify
Merge Push, create PR, merge, cleanup branches

Commands

SpecFlow has two interfaces:

Interface Syntax Purpose
CLI specflow <cmd> State management, task tracking, phase lifecycle
Slash /flow.<cmd> AI-assisted development workflows

CLI Commands

specflow init                # Initialize new project (full 3.0 compliance)
specflow status              # Complete project status
specflow next                # Next actionable task
specflow mark T007           # Mark task complete
specflow check --fix         # Validation with auto-fix
specflow phase open 0020     # Start a phase
specflow phase close         # Close current phase
specflow phase defer "item"  # Defer to backlog

Slash Commands

Command Description
/flow.init Initialize project with discovery interview
/flow.orchestrate Full automated workflow
/flow.design Create all design artifacts
/flow.implement Execute tasks with TDD
/flow.verify Verify completion
/flow.merge Push, PR, merge to main
/flow.roadmap Create/update ROADMAP
/flow.memory Manage memory documents
/flow.review Systematic code review

Full References


Documentation

Guide Description
CLI Reference Complete CLI command reference
Slash Commands All slash commands and options
Project Structure Directory layout and key files
Templates Customizing document templates
Configuration State files and settings
Troubleshooting Common issues and solutions
Integration Guide Working with existing documentation

Requirements

Dependency Version Install
Claude Code Latest Download
Node.js 18+ Required for TypeScript CLI
pnpm 8+ npm install -g pnpm
git 2.0+ Usually pre-installed

Development

# Install dependencies
pnpm install

# Build CLI
pnpm --filter @specflow/cli build

# Run tests
pnpm --filter @specflow/cli test

# Run CLI
specflow status

Upgrade

cd claude-specflow-orchestration
git pull
./install.sh --upgrade
pnpm --filter @specflow/cli build

Contributing

Contributions are welcome! See ROADMAP.md for current development priorities.

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Run tests (pnpm --filter @specflow/cli test)
  5. Submit a Pull Request

Support


License

MIT - See LICENSE for details.

About

Improves upon Github's speckit workflow with orchestration and better project initiation.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •