Setting up SpecForge

The SpecForge suite consists of a few components:

• The SpecForge Server which is the backend server which the other components connect to. It can be run via Docker or as an executable.
• The SpecForge VSCode Extension which provides Lilo Language support in VSCode for editing and managing specifications, as well as rendering interactive visualizations.
• The SpecForge Python SDK which provides an API for interacting with the SpecForge server from Python code. This can be used to communicate and exchange specifications or data with the SpecForge server from Python scripts or Jupyter notebooks.

All necessary files can be obtained from the SpecForge releases page.

Quick Start

Follow these steps to get started quickly:

1. Install dependencies z3 and rsvg-converter (see OS-specific instructions; rsvg-converter is optional)
2. Download and extract the SpecForge executable for your operating system
3. Configure your license (place license.json in the appropriate location for your OS)
4. (Optional) Configure LLM provider by setting environment variables (e.g., LLM_PROVIDER=openai, OPENAI_API_KEY=...) - see LLM Provider Configuration
5. Start the SpecForge server: ./specforge serve (or .\specforge.exe serve on Windows)
6. Install the VSCode Extension (see docs)
7. Create a directory for your project and place your .lilo files directly in it
8. Open the directory in VSCode and start writing specifications

Note: The lilo.toml project configuration file is optional. For initial setup, you can skip it and place your specification and data files directly in the project root. See Project Configuration for details on when and how to use lilo.toml.

Detailed Setup Instructions

Choose your platform for detailed setup instructions:

• Windows - Complete setup guide for Windows
• macOS - Complete setup guide for macOS (Apple Silicon)
• Linux - Complete setup guide for Linux
• Docker - Using Docker instead of the executable