Getting Started
Choose Your Path
SPECLAN works with any project -- whether you are starting fresh or adding specifications to an existing codebase. Pick the guide that matches your situation:
New Project (Greenfield)
Starting from scratch? The New Project guide walks you through the full journey: create a project directory, initialize Git, set up SPECLAN, build your first specification tree, and hand it to your AI coding assistant.
Choose this if: You have a new idea and no existing code yet.
Existing Project (Brownfield)
Already have a codebase? The Existing Project guide shows you how to adopt SPECLAN without disrupting ongoing work. Infer specifications from your code, establish a baseline, and start using SPECLAN for new development.
Choose this if: You have a project with existing code and want to introduce structured specifications.
Quick Start
If you just want to get SPECLAN running:
- Install the SPECLAN extension from the VS Code Marketplace
- Open a workspace folder in VS Code
- Click "Initialize SPECLAN" in the SPECLAN sidebar panel
- Start creating Goals, Features, and Requirements
For the full walkthrough with concept explanations and best practices, follow one of the guides above.