Reference Documentation
Complete technical reference for SpecFact CLI.
Available References
- Commands - Complete command reference with all options
- Thorough Codebase Validation - Quick check, contract-decorated, sidecar, and dogfooding
- Command Syntax Policy - Source-of-truth argument syntax conventions for docs
- Authentication - Device code auth flows and token storage
- Architecture - Technical design, module structure, and internals
- Debug Logging - Where and what is logged when using
--debug - Operational Modes - CI/CD vs CoPilot modes
- Specmatic API - Specmatic integration API reference (functions, classes, integration points)
- Telemetry - Opt-in analytics and privacy guarantees
- Feature Keys - Key normalization and formats
- Directory Structure - Project structure and organization
- Schema Versioning - Bundle schema versions and backward compatibility (v1.0, v1.1)
- Module Security - Marketplace/module integrity and publisher metadata
Quick Reference
Commands
specfact import from-bridge --adapter speckit- Import from external tools via bridge adapterspecfact import from-code <bundle-name>- Reverse-engineer plans from codespecfact plan init <bundle-name>- Initialize new development planspecfact plan compare- Compare manual vs auto plansspecfact enforce stage- Configure quality gatesspecfact repro- Run full validation suitespecfact sync bridge --adapter <adapter> --bundle <bundle-name>- Sync with external tools via bridge adapterspecfact spec validate [--bundle <name>]- Validate OpenAPI/AsyncAPI specificationsspecfact spec generate-tests [--bundle <name>]- Generate contract tests from specificationsspecfact spec mock [--bundle <name>]- Launch mock server for developmentspecfact init ide --ide <cursor|vscode|copilot|...>- Initialize IDE integration explicitlyspecfact module install <name|namespace/name>- Install marketplace module (bare names normalize tospecfact/<name>)specfact module list [--source ...] [--show-origin]- List modules with trust/publisher and optional origin detailsspecfact module show <name>- Show detailed module metadata and full command tree with short descriptionsspecfact module search <query>- Search marketplace and installed modulesspecfact module uninstall <name|namespace/name>/specfact module upgrade [<name>|--all]- Manage module lifecycle with source-aware behavior
Modes
- CI/CD Mode - Fast, deterministic execution
- CoPilot Mode - Enhanced prompts with context injection
IDE Integration
specfact init ide --ide <cursor|vscode|copilot|...>- Set up slash commands in IDE- See IDE Integration Guide for details
Technical Details
- Architecture: See Architecture
- Module Structure: See Architecture - Module Structure
- Operational Modes: See Architecture - Operational Modes
- Agent Modes: See Architecture - Agent Modes
Related Documentation
- Getting Started - Installation and first steps
- Guides - Usage guides and examples
- Examples - Real-world examples