This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

solverforge-cli

Default onboarding CLI for scaffolding, running, and iterating on SolverForge applications.

solverforge-cli is the default way to start a new SolverForge application. It scaffolds a runnable neutral app shell and provides generator commands so you can shape the domain incrementally.

What It Provides

  • Project scaffolding via solverforge new <name>
  • Local runtime with solverforge server
  • Domain growth through solverforge generate ...
  • Generator-owned app metadata in solverforge.app.toml
  • CLI-first onboarding that complements deeper Rust and domain tutorials

Installation

cargo install solverforge-cli

Minimal Workflow

solverforge new my-scheduler
cd my-scheduler
solverforge server

Open http://localhost:7860 after the server starts.

Build Out the App

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 generated shell is intentionally neutral. Standard-variable, list-variable, and mixed apps are shaped after scaffolding rather than chosen as separate starter families.

When To Use It

Use solverforge-cli when you want the fastest path from zero to a running SolverForge app and plan to evolve the generated project with your own model, constraints, and API surface.

Sections

  • Getting Started — Install the CLI, scaffold an app, run the local server, and grow the domain

External References

1 - Getting Started

Install solverforge-cli, scaffold a neutral app shell, and run the default local development server.

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