SolverForge
Search docs Ctrl K

Documentation

Install and use the portable solverforge-ui agent skill that teaches a coding agent to extend a solverforge-cli scaffold into a domain-faithful UI.

Agent Skill

As of solverforge-ui 0.9.0, the solverforge-ui agent skill lives with the other SolverForge skills in the solverforge-cli repository (skills/solverforge-ui/); the solverforge-ui crate no longer bundles it. The skill teaches a coding agent to extend a thin solverforge-cli scaffold into a domain-faithful interface using only the shipped SF.* components, so the planning model stays the single source of truth and the generated backend stays untouched.

It is a playbook over the library, not a second API: the crate README.md at the matching version remains the authoritative contract. The skill’s references carry the judgment calls the API reference does not, such as which scheduling surface expresses a given planning shape and how to map generated records onto timeline, Gantt, map, rail, and table models.

What It Covers

  • Reading a solverforge-cli scaffold and extending its neutral shell instead of replacing it
  • Choosing between the rail timeline, Gantt, the optional map module, low-level rail primitives, and tables for a given optimization shape
  • Mapping generated entities, facts, scalar variables, list variables, and constraints onto component models with integer-minute axes, lanes, items, overlays, tones, and unassigned work
  • The SF.createBackend(...) / SF.createSolver(...) lifecycle contract and the rules that keep it correct
  • Validating the assembled UI in a real browser rather than trusting a successful build

Install

Install the skill from a solverforge-cli checkout with that repository’s installer; see its skills/README.md. The solverforge-ui crate no longer ships an installer of its own. Restart the agent after installing so it rescans skill directories.

How The Skill Is Structured

skills/solverforge-ui/SKILL.md is the workflow and the non-negotiable rules. It points to focused reference files for the task at hand:

Need Reference
Scaffold anatomy, boot contract, ui-model.json, module layout, CSS references/app-architecture.md
Exact SF.* factories, config keys, return values, tones references/components.md
Backend seam, createSolver contract, lifecycle rules references/solver-lifecycle.md
Turning domain records into timeline, Gantt, map, and table models references/data-mapping.md
“Which surface should I build for this problem?” references/problem-shapes.md
Proving the UI works end to end references/validation.md

The skill targets the solverforge-ui version an app pins; check Cargo.lock and that version’s README.md before relying on a detail.

Guardrails The Skill Enforces

The skill is written to keep the generated model and the /sf, /jobs, and /demo-data contract intact:

  • Keep the backend seam. Use SF.createBackend(...) and SF.createSolver(...) rather than hand-rolled fetch or EventSource.
  • Render the app’s records, not a reinvented domain model.
  • Deep-clone every plan before it reaches the solver.
  • Keep timeline time integer-only.
  • Never hand-edit static/generated/ui-model.json.
  • Treat component content as text by default and use the documented unsafeHtml fields only with trusted, escaped content.
  • Surface real lifecycle state rather than optimistic results, and validate in a real browser.

External References