Docs menu

// Command reference

simforge simulate

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

All commands

simforge simulate

Simulate the same scenario file locally or with --cloud

simforge simulate [OPTIONS] <TARGET> [EXTRA]...
Argument / flagNotesWhat
<target>requiredScenario JSON file or materialized workspace; identical input for local and cloud
<extra>repeatableRuntime-specific options; forwarded without shell interpolation
--out OUTOutput folder; local requires it, cloud waits and downloads when it is given
--mode MODEone of 2d, schematic, 3d; default 2d
--rig RIGSensor rig JSON (simforge rig init). Default: the basic-dash-camera rig on the ego
--preset PRESETone of training, showcase, schematicRender preset
--camera-detector FILELocal native render only: authored instantaneous HDR detector response JSON
--camera-temporal FILELocal native render only: bounded exact-time HDR exposure request JSON
--camera-delivery FILELocal bounded offline measurement delivery or controlled delivery-only resume
--fps FPSFrame rate every camera records (2d: the video's), over the render preset's own rate; 3d takes 5 to 60
--waitWait for a submitted cloud job to finish
--downloadDownload a succeeded cloud job into --out; implies --wait
--max-cost CENTSExplicit maximum cloud cost in cents; required for billable cloud jobs
--revision REVISIONImmutable revision for an existing hosted scenario target
--replay-of RUN_IDCloud 3d render: the drive a succeeded closed_loop run scored (its episode timeline), rendered on the target's revision that run drove
--seed SEEDOverride the resolution's seed (the trace is then expected to differ)
--map-dir DIRUse this map directory instead of the installed map found by content (map.xodr[.gz] sha256 = the manifest's map.xodrSha256)
--cache-root DIRMap cache root to search. Default: SIMFORGE_MAPS_CACHE_ROOT, then $XDG_DATA_HOME/simforge/maps
--trace FILEInstance mode (the positional is an instance file): also write the trace here (gzip JSON)
--allow-no-collidersSimulate without map colliders when the map publishes none (recorded in the result; the default refuses)