Welcome to SpecFact CLI! This guide will help you get started in under 60 seconds.
Choose your preferred installation method:
- Installation Guide - All installation options (uvx, pip, Docker, GitHub Actions)
- Enhanced Analysis Dependencies - Optional dependencies for graph-based analysis (pyan3, syft, bearer, graphviz)
For Legacy Code Modernization (Recommended):
# CLI-only mode (works with uvx, no installation needed)
uvx specfact-cli@latest import from-code my-project --repo .
# Interactive AI Assistant mode (requires pip install + specfact init)
# See First Steps guide for IDE integration setupFor New Projects:
# CLI-only mode (bundle name as positional argument)
uvx specfact-cli@latest plan init my-project --interactive
# Interactive AI Assistant mode (recommended for better results)
# Requires: pip install specfact-cli && specfact initNote: Interactive AI Assistant mode provides better feature detection and semantic understanding, but requires pip install specfact-cli and IDE setup. CLI-only mode works immediately with uvx but may show 0 features for simple test cases.
New to brownfield modernization? See our Brownfield Engineer Guide for a complete walkthrough of modernizing legacy Python code with SpecFact CLI.
- 📖 Installation Guide - Install SpecFact CLI
- 📖 First Steps - Step-by-step first commands
- 📖 Tutorial: Using SpecFact with OpenSpec or Spec-Kit ⭐ NEW - Complete beginner-friendly tutorial
- 📖 DevOps Backlog Integration 🆕 NEW FEATURE - Integrate SpecFact into agile DevOps workflows
- 📖 Backlog Refinement 🆕 NEW FEATURE - AI-assisted template-driven refinement for standardizing work items
- 📖 Tutorial: Backlog Refine with AI IDE 🆕 - End-to-end for agile DevOps teams: slash prompt, story quality, underspecification, splitting, DoR, custom templates
- 📖 Tutorial: Daily Standup and Sprint Review 🆕 - End-to-end daily standup: auto-detect repo (GitHub/ADO), view standup table, post comment, interactive, Copilot export
- 📖 Use Cases - See real-world examples
- 📖 Command Reference - Learn all available commands