Skip to content

πŸ’« Toolkit to help you transform your existing codebase into Github Spec Kit managed code, or rebuild it as a new spec-driven greenfield app.

License

Notifications You must be signed in to change notification settings

jschulte/stackshift

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

StackShift

A reverse engineering toolkit that lets you shift gears in your codebase.

Transform any application into a fully-specified, spec-driven project with complete control - whether you're shifting to a new tech stack or taking the wheel on existing code.

GitHub Sponsors Ko-fi

CI Status License Node.js TypeScript

Two paths, two frameworks, complete control:

πŸ”€ Greenfield: Extract business logic from your legacy app, then rebuild in a modern stack using tech-agnostic specs.

βš™οΈ Brownfield: Transform your existing codebase into a spec-driven project for ongoing management.

πŸ› οΈ Choose Your Implementation Framework:

  • GitHub Spec Kit - Feature specs in .specify/, task-driven workflow
  • BMAD Method - PRD + Architecture in docs/, agent-driven workflow

Start in reverse (engineering), shift through 6 gears, and cruise into spec-driven development!

Free and open source. Support development to keep the gears turning! β˜•πŸš—


πŸ“š Documentation


🎯 What StackShift Does

Reverse Engineering Meets Manual Control - StackShift provides a systematic, 6-gear process to:

  1. πŸ” First Gear: Analyze - Detect tech stack and assess completeness
  2. πŸ”„ Second Gear (Reverse!): Reverse Engineer - Extract comprehensive documentation
  3. πŸ“‹ Third Gear: Create Specifications - Transform into GitHub Spec Kit format
  4. πŸ”Ž Fourth Gear: Gap Analysis - Identify what's missing or incomplete
  5. ✨ Fifth Gear: Complete Specification - Resolve ambiguities and clarifications
  6. πŸš€ Sixth Gear: Implement - Build features from specs!

Two Paths - Choose Your Route:

Workflow State Machine

stateDiagram-v2
    [*] --> Analyze
    Analyze --> ReverseEngineer: Gear 2
    ReverseEngineer --> CreateSpecs: Gear 3
    CreateSpecs --> GapAnalysis: Gear 4
    GapAnalysis --> CompleteSpec: Gear 5
    CompleteSpec --> Implement: Gear 6
    Analyze --> CruiseControl: auto mode
    Implement --> [*]
    CruiseControl --> [*]
Loading

Last generated: 2025-11-17T17:24:53.600Z

πŸ”€ Path A: Greenfield (Shift to New Stack)

Use when: Rebuilding in a different tech stack or platform

Approach: Extract business logic ONLY (tech-agnostic)

  • Focus on WHAT the system does, not HOW
  • Framework-agnostic specifications
  • Can implement in any technology
  • Perfect for platform migrations

Example: "Extract business logic from Rails app to rebuild in Next.js"

βš™οΈ Path B: Brownfield (Take the Wheel on Existing Code)

Use when: Managing existing codebase with GitHub Spec Kit

Approach: Extract business logic + technical implementation (tech-prescriptive)

  • Document both WHAT and HOW
  • Capture exact tech stack, versions, file paths
  • Enables /speckit.analyze validation
  • Perfect for ongoing spec-driven development

Two Modes:

  • Standard: Create specs for current state (as-is)
  • Upgrade πŸ†•: Create specs + upgrade all dependencies to latest versions

Example: "Add GitHub Spec Kit to existing Next.js app for spec-driven management" Example (Upgrade): "Spec this legacy app AND upgrade everything to modern versions"

Result: A fully-documented, specification-driven application ready for enterprise development.


πŸš— 6-Gear Process

β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚                  Shift Through 6 Gears                       β”‚
β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€
β”‚                                                              β”‚
β”‚  Gear 1: Initial Analysis + Route + Framework Selection     β”‚
β”‚  β”œβ”€ Run AST analysis (parse codebase, save to cache)        β”‚
β”‚  β”œβ”€ Detect technology stack                                 β”‚
β”‚  β”œβ”€ Choose route: Greenfield or Brownfield?                 β”‚
β”‚  └─ Choose framework: GitHub Spec Kit or BMAD Method?       β”‚
β”‚         β”‚                                                    β”‚
β”‚         β–Ό                                                    β”‚
β”‚  Gear 2: Reverse Engineer (Reverse Gear! πŸ”„)                β”‚
β”‚  β”œβ”€ Extract business logic + tech details                   β”‚
β”‚  β”œβ”€ Enhanced with AST: auto-extract APIs & logic            β”‚
β”‚  └─ Generate 9 docs to docs/reverse-engineering/ (BOTH)     β”‚
β”‚         β”‚                                                    β”‚
β”‚         β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”            β”‚
β”‚         β”‚                 β”‚                    β”‚            β”‚
β”‚    Spec Kit           BMAD Method              β”‚            β”‚
β”‚         β”‚          (Skip to Gear 6)            β”‚            β”‚
β”‚         β–Ό                 β”‚                    β”‚            β”‚
β”‚  Gears 3-5: Spec Kit Path                     β”‚            β”‚
β”‚  β”œβ”€ Gear 3: Create .specify/ specs            β”‚            β”‚
β”‚  β”œβ”€ Gear 4: Gap analysis                      β”‚            β”‚
β”‚  └─ Gear 5: Complete specification            β”‚            β”‚
β”‚         β”‚                 β”‚                    β”‚            β”‚
β”‚         β–Ό                 β–Ό                    β”‚            β”‚
β”‚  Gear 6: Implement / Handoff                                β”‚
β”‚  β”œβ”€ Spec Kit: /speckit.tasks & /speckit.implement           β”‚
β”‚  └─ BMAD: Handoff to *workflow-init (collaborative PRD)     β”‚
β”‚                                                              β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

πŸš€ Quick Start

Three Ways to Use StackShift

Option 1: Claude Code Plugin (Local - Best Experience)

Recommended for: Regular use, local development

Install as a Claude Code plugin for interactive skills and workflow tracking:

# In Claude Code
> /plugin marketplace add jschulte/claude-plugins
> /plugin install stackshift

Restart Claude Code. Skills will now be available:

  • analyze - Initial Analysis
  • reverse-engineer - Reverse Engineer
  • create-specs - Create Specifications
  • gap-analysis - Gap Analysis
  • complete-spec - Complete Specification
  • implement - Implement from Spec

Usage:

Skills auto-activate based on context, or invoke explicitly:

# Auto-activation
User: "I need to reverse engineer this codebase"
Claude: [analyze skill activates automatically]

# Explicit invocation
Just ask naturally: "Run initial analysis" or "Analyze this codebase"

Prerequisites

  • Claude Code with plugin support
  • Git repository with existing codebase
  • Node.js 18+ (for state management scripts)
  • ~2-4 hours total time for complete process

Run the Process

With Plugin (Recommended):

# Navigate to your project
cd /path/to/your/project

# Start Claude Code
# Skills will guide you through the process automatically

Simply say: "I want to reverse engineer this application" and Claude will guide you through all 6 steps.

Initial Configuration:

StackShift will ask a few questions upfront:

  1. Route: Greenfield or Brownfield?
  2. Implementation Framework: GitHub Spec Kit or BMAD Method?
  3. Transmission: Manual or Cruise Control?
  4. (If Cruise Control + Spec Kit) Clarifications strategy & implementation scope
  5. (If Greenfield) Target tech stack

All answers saved to .stackshift-state.json - configure once, use throughout!

Progress Tracking:

# Check which gear you're in
node ~/.claude/plugins/stackshift/plugin/scripts/state-manager.js progress

Without Plugin (Manual):

If not using the plugin, use the web bootstrap for manual execution:

# 1. Clone StackShift
git clone https://github.com/jschulte/stackshift.git

# 2. Use web bootstrap prompt
cat web/WEB_BOOTSTRAP.md
# Copy and paste into Claude.ai or Claude Code Web

# Or use the legacy prompts (for reference):
cat legacy/original-prompts/01-initial-analysis.md

Recommended: Use the web bootstrap or plugin for the best experience.

Option 2: Claude Code Web (Browser - No Install!)

Recommended for: Quick analysis, trying before installing, working on any device

# In Claude Code Web (https://claude.ai/code)
1. Connect to your GitHub account
2. Select your repo from the dropdown
3. Copy-paste web/WEB_BOOTSTRAP.md
4. Hit enter and shift through the gears! πŸš—

See web/README.md for complete instructions.

Benefits:

  • ☁️ Works in browser (any device)
  • πŸš€ No installation required
  • πŸ”„ Full cruise control support
  • πŸ’Ύ Download specs when complete

Option 3: MCP Server (VSCode, Copilot)

Recommended for: VSCode users, GitHub Copilot users

# Configure in VSCode settings.json
{
  "mcp.servers": {
    "stackshift": {
      "command": "npx",
      "args": ["-y", "stackshift-mcp"]
    }
  }
}

See mcp-server/README.md for complete instructions.


πŸ”€ Choose Your Route

StackShift asks this question in Gear 1 (Initial Analysis):

Which path best aligns with your goals?

A) Greenfield: Build new app based on business logic

  • Extract business requirements only (tech-agnostic)
  • Can implement in any stack
  • Focus: WHAT the system does

B) Brownfield: Manage this app with Spec Kit

  • Extract business logic + technical details (prescriptive)
  • Manage existing codebase with specs
  • Focus: WHAT it does + HOW it's implemented

When to Choose Greenfield (Path A)

Perfect for:

  • πŸ”„ Platform migrations - Rails β†’ Next.js, PHP β†’ Python, Monolith β†’ Microservices
  • πŸ—οΈ Technology modernization - Rebuild with modern stack
  • πŸ“± Cross-platform - Web app β†’ Mobile app using same business logic
  • ♻️ Clean slate - Start fresh with better architecture
  • 🎯 Team flexibility - Let new team choose their preferred stack

Results in:

  • Specifications that describe business requirements only
  • No framework or library mentions
  • Can be implemented in ANY technology
  • Example: "User authentication with email/password" (not "JWT via passport.js")

When to Choose Brownfield (Path B)

Perfect for:

  • πŸ“‹ Spec-driven management - Add GitHub Spec Kit to existing codebase
  • πŸ” Validation - Use /speckit.analyze to ensure specs match code
  • ⬆️ Planned upgrades - Manage framework/dependency upgrades via specs
  • πŸ”§ Gradual refactoring - Spec-driven modernization of existing app
  • πŸ‘₯ Team onboarding - Use prescriptive specs as documentation

Results in:

  • Specifications that describe business requirements + exact implementation
  • Framework, library, version details included
  • /speckit.analyze validates code matches specs
  • Example: "User authentication using JWT via jose 5.1.0, bcrypt 5.1.1, stored in httpOnly cookies"

Path Comparison

Aspect Greenfield (A) Brownfield (B)
Focus WHAT only WHAT + HOW
Tech Stack Any (your choice) Current (documented)
Specifications Agnostic Prescriptive
Implementation Build new Manage existing
Flexibility High Constrained to current stack
Validation Manual Automated
Use Case Platform migration Ongoing development

πŸ› οΈ Implementation Framework Choice

After choosing your route (Greenfield/Brownfield), StackShift asks which implementation framework to use:

GitHub Spec Kit (Recommended for most projects)

Output structure:

.specify/
β”œβ”€β”€ memory/
β”‚   β”œβ”€β”€ constitution.md      # Project principles
β”‚   └── [feature-name]/      # Per-feature specs
β”‚       β”œβ”€β”€ spec.md
β”‚       β”œβ”€β”€ plan.md
β”‚       └── tasks.md
└── templates/               # Spec templates

Workflow:

  • /speckit.specify - Create feature specs
  • /speckit.plan - Create implementation plans
  • /speckit.tasks - Generate task lists
  • /speckit.implement - Execute implementation

Best for: Most projects, task-driven development, smaller teams

BMAD Method (For larger/enterprise projects)

Output structure (same as Spec Kit):

docs/reverse-engineering/
β”œβ”€β”€ functional-specification.md   # Business logic, requirements
β”œβ”€β”€ integration-points.md         # External services, APIs
β”œβ”€β”€ configuration-reference.md    # All config options
β”œβ”€β”€ data-architecture.md          # Data models, API contracts
β”œβ”€β”€ operations-guide.md           # Deployment, infrastructure
β”œβ”€β”€ technical-debt-analysis.md    # Issues, improvements
β”œβ”€β”€ observability-requirements.md # Monitoring, logging
β”œβ”€β”€ visual-design-system.md       # UI/UX patterns
└── test-documentation.md         # Testing requirements

Workflow:

  1. StackShift generates docs/reverse-engineering/ (Gears 1-2) - same output as Spec Kit
  2. Gears 3-5 skipped (BMAD's agents handle PRD/Architecture collaboratively)
  3. Gear 6 hands off to BMAD's *workflow-init with rich context
  4. BMAD's PM and Architect agents create artifacts through conversation

Key difference: StackShift provides the same reverse-engineering docs as input. BMAD's value is the collaborative artifact creation - PM agent discusses requirements with you, Architect agent discusses technical decisions with you. The PRD and Architecture emerge from conversation, not auto-generation.

Best for: Large projects, enterprise teams, agent-driven workflows

Framework Comparison

Aspect GitHub Spec Kit BMAD Method
Gear 2 Output Same 9 docs Same 9 docs
Gears 3-5 Create .specify/ specs Skipped (BMAD handles)
Gear 6 /speckit.implement Handoff to *workflow-init
Artifact Creation Automated from docs Collaborative with BMAD agents
Best For Task-driven teams Agent-driven enterprise teams

Note: StackShift's reverse engineering (Gear 2) replaces BMAD's Phase 0 (document-project) with deeper AST-powered analysis. Both frameworks get the same rich context.


πŸ“ StackShift Structure

Plugin Structure (Recommended)

stackshift/
β”œβ”€β”€ README.md                           ← You are here
β”œβ”€β”€ .claude-plugin/
β”‚   └── marketplace.json               ← Plugin marketplace config
β”œβ”€β”€ plugin/
β”‚   β”œβ”€β”€ .claude-plugin/
β”‚   β”‚   └── plugin.json                ← Plugin metadata
β”‚   β”œβ”€β”€ skills/
β”‚   β”‚   β”œβ”€β”€ analyze/                   ← Step 1: Initial Analysis
β”‚   β”‚   β”‚   β”œβ”€β”€ SKILL.md               ← Skill definition
β”‚   β”‚   β”‚   └── operations/            ← Sub-operations
β”‚   β”‚   β”œβ”€β”€ reverse-engineer/          ← Step 2: Reverse Engineer
β”‚   β”‚   β”œβ”€β”€ create-specs/              ← Step 3: Create Specifications
β”‚   β”‚   β”œβ”€β”€ gap-analysis/              ← Step 4: Gap Analysis
β”‚   β”‚   β”œβ”€β”€ complete-spec/             ← Step 5: Complete Specification
β”‚   β”‚   └── implement/                 ← Step 6: Implement from Spec
β”‚   β”œβ”€β”€ templates/                     ← Spec templates
β”‚   β”‚   β”œβ”€β”€ feature-spec-template.md
β”‚   β”‚   β”œβ”€β”€ constitution-agnostic-template.md
β”‚   β”‚   β”œβ”€β”€ constitution-prescriptive-template.md
β”‚   β”‚   └── implementation-status-template.md
β”‚   └── scripts/
β”‚       └── state-manager.js           ← Progress tracking
β”œβ”€β”€ web/                               ← Web prompts (for manual use)
β”‚   β”œβ”€β”€ WEB_BOOTSTRAP.md               ← Bootstrap for claude.ai
β”‚   └── convert-reverse-engineering-to-speckit.md
└── legacy/
    └── original-prompts/              ← Legacy manual prompts (archived)

Plugin Benefits

Why use the plugin over manual prompts?

βœ… Auto-activation - Skills activate based on context, no copy-paste needed βœ… Progress tracking - State management tracks where you are (which gear) βœ… Resume capability - Pick up where you left off if interrupted βœ… Guided experience - StackShift knows the full context and next steps βœ… Templates included - Access all templates without file operations βœ… Updates - Get improvements via plugin updates βœ… Smooth shifting - Seamless transitions between steps


πŸ“– Detailed Process Guide

Step 1: Initial Analysis (5 minutes)

What it does:

  • Runs AST analysis - Parses codebase with Babel, saves to .stackshift-analysis/
  • Detects programming language and framework
  • Identifies application type (web, mobile, API, etc.)
  • Maps directory structure
  • Finds configuration files
  • Estimates codebase size and completeness

Output:

  • analysis-report.md with tech stack summary
  • .stackshift-analysis/ cache directory:
    • roadmap.md - Gap analysis with confidence scores
    • raw-analysis.json - Full AST data (functions, classes, APIs)
    • summary.json - Metadata and timestamps
  • Quick assessment of what exists

AST Cache Benefits:

  • βœ… Parse codebase ONCE in Gear 1
  • βœ… All other gears read from cache (instant)
  • βœ… Auto-refresh if stale (> 1 hour)
  • βœ… 50-90% performance improvement

Plugin Skill: /stackshift:analyze Manual: Use web/WEB_BOOTSTRAP.md (Gear 1)


Step 2: Reverse Engineer (30 minutes)

What it does:

  • Deep codebase analysis using specialized agents
  • Enhanced with AST cache - Auto-extracts APIs, business logic from parsed code
  • Extracts all data models, API endpoints, components
  • Documents configuration, infrastructure, operations
  • Analyzes technical debt and test coverage
  • Generates 9 comprehensive documents

Output:

docs/reverse-engineering/
β”œβ”€β”€ functional-specification.md     (Business logic, requirements)
β”œβ”€β”€ integration-points.md           (External services, APIs, dependencies)
β”œβ”€β”€ configuration-reference.md      (All config options)
β”œβ”€β”€ data-architecture.md            (Data models, API contracts)
β”œβ”€β”€ operations-guide.md             (Deployment, infrastructure)
β”œβ”€β”€ technical-debt-analysis.md      (Issues, improvements)
β”œβ”€β”€ observability-requirements.md   (Monitoring, logging)
β”œβ”€β”€ visual-design-system.md         (UI/UX patterns)
└── test-documentation.md           (Testing requirements)

Plugin Skill: /stackshift:reverse-engineer Manual: Use web/WEB_BOOTSTRAP.md (Gear 2)


Step 3: Create Specifications (30 minutes)

What it does:

  • Transforms reverse-eng docs into formal specifications
  • Creates feature specs (F001-F0XX format)
  • Marks implementation status (βœ… COMPLETE, ⚠️ PARTIAL, ❌ MISSING)
  • Generates OpenAPI specification for APIs
  • Creates JSON Schemas for data models
  • Sets up GitHub Spec Kit structure

Output:

specs/
β”œβ”€β”€ features/
β”‚   β”œβ”€β”€ F001-user-authentication.md     (βœ… COMPLETE)
β”‚   β”œβ”€β”€ F002-data-management.md         (⚠️ PARTIAL)
β”‚   β”œβ”€β”€ F003-advanced-features.md       (❌ MISSING)
β”‚   └── ...
β”œβ”€β”€ api/
β”‚   └── openapi.yaml                    (Complete API spec)
β”œβ”€β”€ data/
β”‚   └── schemas/                        (JSON Schemas)
β”œβ”€β”€ implementation-status.md            (Gap summary)
└── constitution.md                     (Project principles)

Plugin Skill: /stackshift:create-specs Manual: Use web/WEB_BOOTSTRAP.md (Gear 3)


Step 4: Gap Analysis (15 minutes)

What it does:

  • Compares specifications against implementation
  • Identifies incomplete features
  • Lists missing UI components
  • Highlights technical debt
  • Creates [NEEDS CLARIFICATION] markers for ambiguities
  • Generates prioritized gap list

Output:

specs/gap-analysis.md
β”œβ”€β”€ Missing Features (not started)
β”œβ”€β”€ Partial Features (backend done, UI missing)
β”œβ”€β”€ Technical Debt (needs improvement)
β”œβ”€β”€ Clarifications Needed (ambiguous requirements)
└── Prioritized Implementation Plan

Plugin Skill: /stackshift:gap-analysis Manual: Use web/WEB_BOOTSTRAP.md (Gear 4)


Step 5: Complete Specification (30-60 minutes, INTERACTIVE)

What it does:

  • Interactive conversation to fill specification gaps
  • Claude asks clarifying questions about missing features
  • You provide details on UX, UI, behavior, priorities
  • Specifications updated with your answers
  • [NEEDS CLARIFICATION] markers resolved
  • Final, complete specification created

Example Questions:

  • "Analytics dashboard is missing - what charts do you want?"
  • "Should offline sync be priority P0 or P2?"
  • "For photo upload, drag-drop or click to browse?"
  • "Species input: free-text or autocomplete dropdown?"

Output:

  • Complete, unambiguous specifications
  • No [NEEDS CLARIFICATION] markers remaining
  • Clear implementation roadmap
  • Prioritized feature list

Plugin Skill: /stackshift:complete-spec Manual: Use web/WEB_BOOTSTRAP.md (Gear 5)


Step 6: Implement from Spec (Hours to Days)

What it does:

  • Systematically implements missing features from specs
  • Works through prioritized list (P0 β†’ P1 β†’ P2)
  • Checks off items as completed
  • Validates implementation against specification
  • Achieves 100% completion

Approach:

# For each missing feature:
1. Review specification
2. Implement according to spec
3. Test against acceptance criteria
4. Mark as complete
5. Move to next feature

Output:

  • Fully implemented application
  • All specs marked βœ… COMPLETE
  • Test coverage at target levels
  • Production-ready codebase

Plugin Skill: /stackshift:implement Manual: Use web/WEB_BOOTSTRAP.md (Gear 6)


πŸ”„ Adapting for Different Application Types

This toolkit works for:

Web Applications

  • Frontend frameworks: React, Vue, Angular, Svelte
  • Backend: Node.js, Python, Ruby, Go, Java
  • Databases: SQL, NoSQL, any data store

Mobile Applications

  • React Native, Flutter, Swift, Kotlin
  • Adapts documentation to mobile-specific patterns

APIs / Microservices

  • REST, GraphQL, gRPC
  • Generates OpenAPI/AsyncAPI specs
  • Documents service contracts

Monoliths

  • Breaks into logical modules
  • Creates specifications per domain
  • Identifies bounded contexts

Legacy Systems

  • Works even with minimal documentation
  • Infers behavior from code
  • Creates modernization roadmap

πŸ“‹ Checklist: Is This Toolkit Right for You?

Use this toolkit if:

  • βœ… You have an existing codebase (partial or complete)
  • βœ… Documentation is lacking or outdated
  • βœ… You want to establish spec-driven development
  • βœ… You need to understand what's implemented vs. missing
  • βœ… You want a systematic approach to completion
  • βœ… You're using AI coding agents (Claude Code, Copilot, etc.)

This toolkit is NOT for:

  • ❌ Brand new projects (use GitHub Spec Kit from the start)
  • ❌ Throwaway prototypes
  • ❌ Applications you plan to completely rewrite

πŸ’‘ Best Practices

Before Starting

  1. Commit current state - Create a clean git state
  2. Create a branch - Don't work on main
  3. Set aside time - Steps 1-5 take ~2-4 hours
  4. Have context ready - Know your app's purpose and users

During Process

  1. Follow prompts in order - Each step builds on previous
  2. Don't skip Step 5 - The interactive refinement is crucial
  3. Be thorough with clarifications - Vague specs = buggy implementations
  4. Review generated specs - Validate accuracy before implementing

After Completion

  1. Keep specs updated - Update specs when adding features
  2. Use spec-driven workflow - New features start with specs
  3. Run periodically - Re-run on major refactors or after acquisitions

πŸ› οΈ Troubleshooting

"Claude can't find my configuration files"

  • Make sure you're in the project root directory
  • Check that config files aren't gitignored
  • Explicitly mention unusual config locations

"Generated specs are inaccurate"

  • Step 5 is where you correct inaccuracies
  • Use [NEEDS CLARIFICATION] to mark uncertain areas
  • Review and refine before implementing

"Too much output, can't process"

  • Break large monoliths into modules
  • Run toolkit per module/microservice
  • Increase context window (use Claude Sonnet 4.5)

"Missing important features in gap analysis"

  • Manually add to specs/features/
  • Use templates in templates/ folder
  • Re-run Step 4 with hints about what's missing

πŸ“ˆ Success Metrics

After running this toolkit, you should have:

  • βœ… 100% documentation coverage - Every feature documented
  • βœ… Clear implementation status - Know exactly what exists
  • βœ… Formal specifications - Unambiguous feature definitions
  • βœ… Identified gaps - Complete list of missing pieces
  • βœ… Implementation roadmap - Prioritized plan to completion
  • βœ… Spec-driven workflow - Established for future development

🀝 Contributing

This toolkit is designed to be:

  • Generic - Works for any application
  • Extensible - Add your own prompts/templates
  • Shareable - Use across teams and organizations

Improvements welcome:

  1. Fork this toolkit
  2. Add/improve prompts or templates
  3. Share back with community
  4. Help others achieve spec-driven development

πŸ“š Additional Resources


πŸ“ License

This toolkit is provided as-is for use in any project. Adapt and modify as needed for your organization.


❓ Questions & Feedback

This toolkit was created to solve a real problem: transforming partially-complete applications into fully-specified, enterprise-grade codebases.

Encountered an issue or have a suggestion?

The toolkit improves with real-world usage and community feedback!


Happy Shifting! πŸš—πŸ’¨

Start in reverse (engineering), shift through 6 gears, cruise into spec-driven development.

About

πŸ’« Toolkit to help you transform your existing codebase into Github Spec Kit managed code, or rebuild it as a new spec-driven greenfield app.

Resources

License

Stars

Watchers

Forks

Sponsor this project

  •  

Packages

No packages published

Contributors 3

  •  
  •  
  •