SpecFact CLI Documentation

Brownfield-first CLI: Reverse engineer legacy Python → specs → enforced contracts

SpecFact CLI helps you modernize legacy codebases by automatically extracting specifications from existing code and enforcing them at runtime to prevent regressions.

🚀 Quick Start

New to SpecFact CLI?

Primary Use Case: Modernizing legacy Python codebases

Installation - Get started in 60 seconds
First Steps - Run your first command
Modernizing Legacy Code ⭐ PRIMARY - Brownfield-first guide
The Brownfield Journey ⭐ - Complete modernization workflow

Using GitHub Spec-Kit?

Secondary Use Case: Add automated enforcement to your Spec-Kit projects

From Spec-Kit to SpecFact - Add enforcement to Spec-Kit projects
Spec-Kit Comparison - Understand when to use each tool

📚 Documentation

Guides

UX Features - Progressive disclosure, context detection, intelligent suggestions
Use Cases - Real-world scenarios and workflows
IDE Integration - Set up slash commands in your IDE
CoPilot Mode - Using --mode copilot on CLI
Troubleshooting - Common issues and solutions
Competitive Analysis - How SpecFact compares

Reference

Command Reference - Complete command documentation
Architecture - Technical design and principles
Operational Modes - CI/CD vs CoPilot modes
Directory Structure - Project structure

Examples

Brownfield Examples - Real-world modernization examples
Quick Examples - Code snippets and patterns

🆘 Getting Help

Documentation

You’re here! Browse the guides above.

Community

💬 GitHub Discussions - Ask questions
🐛 GitHub Issues - Report bugs

Direct Support

📧 Email: hello@noldai.com

🤝 Contributing

Found an error or want to improve the docs?

Fork the repository
Edit the markdown files in docs/
Submit a pull request

See CONTRIBUTING.md for guidelines.

Happy building! 🚀

Trademarks: All product names, logos, and brands mentioned in this documentation are the property of their respective owners. NOLD AI (NOLDAI) is a registered trademark (wordmark) at the European Union Intellectual Property Office (EUIPO). See TRADEMARKS.md for more information.

License: See LICENSE.md for licensing information.