SpecFact CLI Documentation
Review AI-assisted code against your own contracts. Catch drift before it reaches PR or main.
Point SpecFact at your repo, get a scored review with file-level findings, then go deeper into backlog, specs, and CI when you need more control.
uvx specfact-cli init --profile solo-developer
uvx specfact-cli code review run --path . --scope full
You should see a Verdict, a Score, and a list of findings on a real repo. That is the fastest way to see SpecFact on existing code. Read the full quickstart →
SpecFact does not include built-in AI. It pairs deterministic CLI commands with your chosen IDE and copilot so fast-moving work has a stronger validation and alignment layer around it.
SpecFact is the validation and alignment layer for software delivery.
What is SpecFact?
SpecFact helps you keep backlog intent, specifications, implementation, and validation from drifting apart. It supports spec-first handoffs with OpenSpec and spec-kit-style workflows so brownfield and AI-assisted teams can keep backlog language, specs, and code aligned.
It is especially useful when:
- AI-assisted or “vibe-coded” work needs more rigor
- brownfield and legacy code need trustworthy reverse-engineered understanding of existing systems
- teams want to avoid the “I wanted X but got Y” delivery failure
- organizations need a path toward stronger shared policy enforcement
Why does it exist?
SpecFact exists because backlog/spec/code drift is expensive: teams ship the wrong thing, AI-assisted changes skip validation, and policy enforcement breaks down across IDEs and CI. SpecFact gives you a default starting point before you jump into module-deep workflows on the modules site.
Why should I use it?
Use SpecFact when you want faster delivery without losing validation, stronger brownfield understanding before making changes, and less drift between backlog intent, specifications, and the code that actually lands.
What do I get?
With SpecFact, you get:
- deterministic local tooling instead of opaque cloud dependence
- a validation layer around AI-assisted delivery
- codebase analysis and sidecar validation for brownfield work
- stronger backlog/spec/code alignment
- a clean handoff from this site into module-deep workflows on modules.specfact.io
How to get started
- Installation — uvx (no install) or pip (persistent CLI)
- 5-Minute Quickstart — First commands on a repo
- specfact init — Profiles, bundles, and IDE setup
- Bootstrap Checklist — Verify bundle readiness
Choose your path
See what's wrong with your code right now
Run a scored code review on an existing repo with uvx, then iterate.
Set up IDE slash-command workflows
Install the CLI, bootstrap bundles, then export prompts for Cursor, VS Code, and other IDEs.
Add a pre-commit or CI gate
Wire SpecFact into local hooks or GitHub Actions for repeatable checks.
Core Platform
The specfact-cli package provides the stable platform surface:
- specfact init — Bootstrap bundles and optional IDE setup
- specfact module — Install, enable, and upgrade workflow modules
- specfact upgrade — CLI self-update
Installed modules add command groups such as project, backlog, code, spec, and govern. Deeper bundle docs live on modules.specfact.io.
Modules Documentation
docs.specfact.io is the default starting point and the canonical starting point for the core CLI story
for first-time readers on this site. Move to the modules site when you need module-deep workflows,
bundle-specific adapters, and authoring guidance.
- Modules Docs Home - Backlog, project, spec, govern
- Module Development - Build your own modules
- Publishing Modules - Publish to marketplace
Module System
- Installing Modules - Install and manage modules
- Module Marketplace - Registry model and discovery
- Marketplace Bundles - Official bundle IDs and trust tiers
- Custom Registries - Private registry configuration
Architecture
- Architecture Overview - Current architecture model
- Architecture Docs - Component graph, data flow, state machines
- Implementation Status - Implemented vs planned
- ADRs - Architecture decision records
Workflows
- AI IDE Workflow - Bootstrap editor integrations around the CLI
- Agile & Scrum Workflows - Team routines anchored in the core runtime
- Command Chains - Compose core and module commands safely
- Contract Testing Workflow - Core validation and contract-first delivery
Reference
- Command Reference - Full command surface
- Module Categories - Category taxonomy
- Module Contracts - Contract interfaces
- Operational Modes - CI/CD and CoPilot modes
- Debug Logging - Diagnostic logging
Migration
- Migration Guide - Version upgrade guidance
- CLI Reorganization - Command surface changes
- OpenSpec Migration - OPSX workflow migration