Docs menu

// Command reference

simforge runtime

Generated from the CLI's own help (CLI 0.2.0-rc.9). Global flags and exit codes are on the reference index.

All commands

simforge runtime install

Download and install the closed runtime (PolyForm Noncommercial 1.0.0) after accepting its license and SimForge's account and download terms

simforge runtime install [OPTIONS]
Argument / flagNotesWhat
--target TARGETdefault host targetThe platform to download for (a Rust target triple). Default: this machine's
--version VERSIONThe exact runtime release to install. Default: the one this CLI pins
--root ROOTWhere to install the runtime. Default: SIMFORGE_RUNTIME_ROOT, then the root of the last install, then <data home>/simforge/runtime. The root is recorded in the CLI config, so runtime status, doctor and every local command find it; the download and its unpacking stay inside it
--for LEVELone of 2d, 3dWhat to install the runtime for: 2d (authoring, simulation and 2D renders: the runtime without the 3D actor models and sky, about 1/30 of the download) or 3d (also local 3D renders). Default: what is installed, else 2d
--accept-licenseExplicitly accept the current license and terms (agreement version and SHA) before downloading

simforge runtime license

Read the runtime license (PolyForm Noncommercial 1.0.0) and SimForge's account and download terms without accepting them

simforge runtime license [OPTIONS]

simforge runtime status

Report the installed runtime's protocol and engine identity; --available also lists what runtime install would download, with sizes

simforge runtime status [OPTIONS]
Argument / flagNotesWhat
--availableAlso list the runtime releases this account can install for this machine (2d, 3d), each with its version, download and installed size; works before any runtime is installed