Claude Code Spec Workflow

Automated spec-driven workflow for Claude Code. Transform feature ideas into complete implementations through Requirements → Design → Tasks → Implementation.

🚀 Quick Start

Install and run in any project directory:

npx @pimzino/claude-code-spec-workflow

That's it! The workflow will be automatically set up in your project.

📦 Installation Options

NPX (Recommended)

# Run once in your project directory
npx @pimzino/claude-code-spec-workflow

# Test the setup
npx @pimzino/claude-code-spec-workflow test

Global Installation

# Install globally
npm install -g @pimzino/claude-code-spec-workflow

# Use anywhere
claude-spec-setup

Local Installation

# Install as dev dependency
npm install --save-dev @pimzino/claude-code-spec-workflow

# Run via package.json script
npx claude-spec-setup

🎯 What It Does

The setup automatically creates:

• 📁 .claude/ directory structure with all necessary files
• 📝 7 slash commands for the complete workflow
• 📋 Document templates for consistent formatting
• ⚙️ Configuration files for workflow automation
• 📖 CLAUDE.md with comprehensive workflow instructions

🔄 Workflow Overview

1. Requirements Phase (/spec-requirements)

• Generates user stories and acceptance criteria
• Uses EARS format (WHEN/IF/THEN statements)
• Ensures comprehensive requirement coverage

2. Design Phase (/spec-design)

• Creates technical architecture and design
• Includes Mermaid diagrams for visualization
• Plans components, interfaces, and data models

3. Tasks Phase (/spec-tasks)

• Breaks design into atomic coding tasks
• References specific requirements
• Focuses on test-driven development

4. Implementation Phase (/spec-execute)

• Executes tasks systematically
• Validates against requirements
• Ensures quality and consistency

🛠️ Usage

After setup, use these commands in Claude Code:

# Create a new feature spec
/spec-create user-authentication "Secure login system"

# Generate requirements document
/spec-requirements

# Create design document
/spec-design

# Generate implementation tasks
/spec-tasks

# Execute specific tasks
/spec-execute 1

# Check status
/spec-status

# List all specs
/spec-list

📊 Command Line Options

# Setup in current directory
npx @pimzino/claude-code-spec-workflow

# Setup in specific directory
npx @pimzino/claude-code-spec-workflow --project /path/to/project

# Force overwrite existing files
npx @pimzino/claude-code-spec-workflow --force

# Skip confirmation prompts
npx @pimzino/claude-code-spec-workflow --yes

# Test the setup
npx @pimzino/claude-code-spec-workflow test

🎨 Features

✅ Zero Configuration

• Works out of the box with any project
• Auto-detects project type (Node.js, Python, Java, etc.)
• Validates Claude Code installation

✅ Interactive Setup

• Beautiful CLI with progress indicators
• Confirmation prompts for safety
• Helpful error messages and guidance

✅ Smart File Management

• Preserves existing CLAUDE.md content
• Creates comprehensive directory structure
• Includes all necessary templates and configs

✅ Professional Quality

• TypeScript implementation
• Comprehensive error handling
• Follows npm best practices

🏗️ Project Structure After Setup

your-project/
├── .claude/
│   ├── commands/
│   │   ├── spec-create.md
│   │   ├── spec-requirements.md
│   │   ├── spec-design.md
│   │   ├── spec-tasks.md
│   │   ├── spec-execute.md
│   │   ├── spec-status.md
│   │   └── spec-list.md
│   ├── templates/
│   │   ├── requirements-template.md
│   │   ├── design-template.md
│   │   └── tasks-template.md
│   ├── specs/
│   │   └── (your specs will be created here)
│   └── spec-config.json
└── CLAUDE.md (created/updated)

🧪 Testing

The package includes a built-in test command:

# Test setup in temporary directory
npx @pimzino/claude-code-spec-workflow test

📋 Requirements

• Node.js 16.0.0 or higher
• Claude Code installed and configured
• Any project directory

🔧 Troubleshooting

Common Issues

❓ Command not found after NPX

# Make sure you're using the correct package name
npx @pimzino/claude-code-spec-workflow

❓ Setup fails with permission errors

# Try with different directory permissions
npx @pimzino/claude-code-spec-workflow --project ~/my-project

❓ Claude Code not detected

# Install Claude Code first
npm install -g @anthropic-ai/claude-code

Debug Information

# Show verbose output
DEBUG=* npx @pimzino/claude-code-spec-workflow

# Check package version
npx @pimzino/claude-code-spec-workflow --version

🌟 Examples

Basic Usage

cd my-awesome-project
npx @pimzino/claude-code-spec-workflow
claude
# Type: /spec-create user-dashboard "User profile management"

Advanced Usage

# Setup multiple projects
for dir in project1 project2 project3; do
  npx @pimzino/claude-code-spec-workflow --project $dir --yes
done

📚 Documentation

• Full Documentation
• Claude Code Docs

🤝 Contributing

Contributions are welcome! Please see our Contributing Guide.

📄 License

MIT License - see LICENSE for details.

🏷️ Changelog

See CHANGELOG.md for version history.

---

Transform your development workflow with automated spec-driven development! 🚀

Made with ❤️ by Pimzino

Acknowledgments

• Claude Code
• Kiro
• Easy Approach to Requirements Syntax
• Mermaid
• Prettier
• ESLint
• Jest