Docs menu

// Command reference

simforge import

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 import log

A recording (simforge.recording/v1 or log-scene/v1) as a scenario package: scenario, recording, trace, import report

simforge import log [OPTIONS] --map <DIR|NAME@VERSION> --out <DIR> <RECORDING>

Runs on: local runtime, or hosted with --cloud

Argument / flagNotesWhat
<recording>requiredThe recording (JSON, optionally gzipped). With --cloud: The log: a recording (JSON, optionally gzipped) or a ROS 2 MCAP lidar log
--map DIR|NAME@VERSIONrequiredThe installed map: a map directory, or name[@version] under the maps cache (semantic profile)
--out DIRrequiredThe package directory to write (created; must be empty if it exists)
--report REPORT.JSONThe register step's import report (simforge.import-report/v1 fields: methods, registration, laneMatch, droppedActors), merged into the package's
--cache-root DIRMap cache root to search for NAME@VERSION. Default: SIMFORGE_MAPS_CACHE_ROOT, then $XDG_DATA_HOME/simforge/maps
--assets-root DIRActor-asset root whose closure restricts catalog binding to renderable models. Default: SIMFORGE_ACTOR_ASSETS_ROOT, then $XDG_DATA_HOME/simforge/actor-assets
--actor-closure SHA256The actor closure the package pins (default: this CLI's pinned public closure)
--allow-no-collidersSimulate without map colliders when the map publishes none (recorded; the default refuses)
--feasibility-report FILEAlso write the opt-in ego feasibility report (simforge.ego-feasibility/v1) to this file: the logged ego track against its class's dynamic-v1 envelope. Never changes the trace or the workspace
--tracked-replay FILEOpt in to a tracked replay of the ego: instead of placing it on the log, drive its dynamic-v1 plant along the logged path (the engine's timed-path tracker) and write the tracking report (simforge.ego-tracking/v1) to this file. Changes the trace; other actors still replay exactly. Recorded in the package notes
--name NAMEThe scenario's name. Default: the file's name
--max-cost CENTSExplicit maximum cloud cost in cents
--waitone of true, falseWait for the import to finish and print its scenario
--downloadone of true, falseDownload a finished import's scenario document, import report and Event Timeline into --out; implies --wait
--stageone of true, falseUpload the log and price its import, starting nothing (the host prices an import from the uploaded log). --dry-run uploads nothing
--lidar-topic TOPICMCAP only: the lidar topic, when the log has several
--gnss-topic TOPICMCAP only: the GNSS topic, when the log has several
--ego-dims L,W,HrepeatableMCAP only: the ego's box in metres, length,width,height (perceive's default otherwise)
--ego-rear-axle-to-centre METRESMCAP only: how far the ego box's centre is ahead of base_link (the rear axle), metres

simforge import openscenario

An OpenSCENARIO 1.x XML file as a scenario package; its map is found by the OpenDRIVE's sha256, and every element it cannot represent is refused by name

simforge import openscenario [OPTIONS] --out <DIR> <FILE.xosc>

Runs on: local runtime, or hosted with --cloud

Argument / flagNotesWhat
<file.xosc>requiredThe OpenSCENARIO 1.x XML file; its catalogs and OpenDRIVE are read beside it. With --cloud: The OpenSCENARIO 1.x file (its OpenDRIVE and catalogs are bundled from the paths it names), or a ready .zip bundle
--out DIRrequiredThe package directory to write (created; must be empty if it exists)
--map-version DIR|NAME@VERSIONThe map version: a map directory, or name[@version] under the maps cache. It must hold the file's OpenDRIVE. Default: the installed map whose OpenDRIVE has the file's sha256
--ego ENTITYThe ego entity (default: one named ego or hero, else the first vehicle)
--clip-seconds SThe clip, when the storyboard does not stop at a simulation time
--cache-root DIRMap cache root to search. Default: SIMFORGE_MAPS_CACHE_ROOT, then $XDG_DATA_HOME/simforge/maps
--assets-root DIRActor-asset root whose closure restricts catalog binding to renderable models. Default: SIMFORGE_ACTOR_ASSETS_ROOT, then $XDG_DATA_HOME/simforge/actor-assets
--actor-closure SHA256The actor closure the package pins (default: this CLI's pinned public closure)
--allow-no-collidersSimulate without map colliders when the map publishes none (recorded; the default refuses)
--map NAME@VERSION|autodefault autoThe map: a map version id, a name, name@vN, or auto (the map whose OpenDRIVE the file names)
--name NAMEThe scenario's name. Default: the file's name
--xosc-path PATHThe .xosc inside a .zip bundle that holds several
--max-cost CENTSExplicit maximum cloud cost in cents
--waitone of true, falseWait for the import to finish and print its scenario
--downloadone of true, falseDownload a finished import's scenario document, import report and Event Timeline into --out; implies --wait
--stageone of true, falseUpload the bundle and price its import, starting nothing: the host resolves the map first, so this shows osc_map_unknown for free. --dry-run uploads nothing