Reference Documentation

Complete technical reference for the official modules site and bundle-owned workflow surface area.

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
• Module Categories - Category grouping model, canonical module assignments, bundles, and first-run profiles
• Dependency resolution - How module/pip dependency resolution works and bypass options

Quick Reference

Commands

• specfact project sync bridge --adapter speckit --bundle <bundle-name> - Import from external tools via bridge adapter
• specfact code import <bundle-name> - Reverse-engineer plans from code
• specfact code analyze contracts - Analyze contract coverage for a codebase bundle
• specfact govern enforce stage - Configure quality gates
• specfact code repro - Run the reproducibility validation suite
• specfact project sync bridge --adapter <adapter> --bundle <bundle-name> - Sync with external tools via bridge adapter
• specfact spec validate [--bundle <name>] - Validate OpenAPI/AsyncAPI specifications
• specfact spec generate-tests [--bundle <name>] - Generate contract tests from specifications
• specfact spec mock [--bundle <name>] - Launch mock server for development
• specfact init ide --ide <cursor|vscode|copilot|...> - Initialize IDE integration explicitly
• specfact module install <name|namespace/name> [--scope user|project] [--source auto|bundled|marketplace] [--repo PATH] - Install modules with scope and source control
• specfact module list [--source ...] [--show-origin] [--show-bundled-available] - List modules with trust/publisher, optional origin details, and optional bundled-not-installed section
• specfact module show <name> - Show detailed module metadata and full command tree with short descriptions
• specfact module search <query> - Search marketplace and installed modules
• specfact 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