Examples
Real-world examples of using SpecFact CLI.
Available Examples
- Integration Showcases ⭐ START HERE - Real bugs fixed via VS Code, Cursor, GitHub Actions integrations
- CLI-First: Works offline, no account required, integrates with any IDE
- Start with the Integration Showcases README for an overview
- Read the main showcase document for real examples
- Brownfield Examples ⭐ NEW - Complete hard-SDD workflow demonstrations
- Django Modernization - Legacy Django app → contract-enforced modern codebase
- Flask API - Legacy Flask API → contract-enforced modern service
- Data Pipeline - Legacy ETL pipeline → contract-enforced data processing
- All examples now include:
plan harden,enforce sdd,plan review, andplan promotewith SDD validation
- Quick Examples - Quick code snippets for common tasks, including SDD workflow
- Dogfooding SpecFact CLI - We ran SpecFact CLI on itself (< 10 seconds!)
Quick Start
See It In Action
For Brownfield Modernization (Recommended):
Read the complete brownfield examples to see the hard-SDD workflow:
This example shows the complete workflow:
- ⚡ Extract specs from legacy code → 23 features, 112 stories in 8 seconds
- 📋 Create SDD manifest → Hard spec with WHY/WHAT/HOW, coverage thresholds
- ✅ Validate SDD → Hash match, coverage threshold validation
- 📊 Review plan → SDD validation integrated, ambiguity resolution
- 🚀 Promote plan → SDD required for “review” or higher stages
- 🔒 Add contracts → Runtime enforcement prevents regressions
- 🔍 Re-validate SDD → Ensure coverage thresholds maintained
For Quick Testing:
This example shows:
- ⚡ Analyzed 19 Python files → Discovered 19 features and 49 stories in 3 seconds
- 🚫 Set enforcement to “balanced” → Blocked 2 HIGH violations (as configured)
- 📊 Compared manual vs auto-derived plans → Found 24 deviations in 5 seconds
| Total time: < 10 seconds | Total value: Found real naming inconsistencies and undocumented features |
Related Documentation
- Use Cases - More real-world scenarios
- Getting Started - Installation and setup
- Command Reference - All available commands