Getting Started

Getting Started with solverforge-cli

This guide covers the current onboarding path:

1. install solverforge-cli
2. scaffold a project shell
3. run the local server
4. grow the domain with generator commands

Prerequisites

• Rust stable toolchain
• Cargo (included with Rust)

Install the CLI

cargo install solverforge-cli

If you already installed it previously, update to the latest published crate:

cargo install solverforge-cli --force

Create a New Project

The current scaffold command creates a neutral app shell:

solverforge new my-scheduler
cd my-scheduler

Use solverforge --version to see the CLI version and the runtime/UI target versions baked into newly scaffolded projects.

Run the Local Server

solverforge server

Open http://localhost:7860 in your browser.

Grow the Domain

Add facts, entities, variables, and sample data incrementally:

solverforge generate fact resource --field category:String --field load:i32
solverforge generate entity task --field label:String --field priority:i32
solverforge generate variable resource_idx --entity Task --kind standard --range resources --allows-unassigned
solverforge generate data --size large

The scaffold is intentionally neutral. Standard-variable, list-variable, and mixed modeling shapes are introduced later through generation and solverforge.app.toml.

Next Steps

• Continue with Getting Started for a broader onboarding map.
• Follow the Employee Scheduling tutorial for a deeper domain-model walkthrough.
• Explore SolverForge API-focused documentation for modeling and constraints.