Docs menu

// Command reference

simforge scenarios

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 scenarios copy

Copy a hosted scenario to edit: its current draft as a new scenario; renders and runs stay

simforge scenarios copy [OPTIONS] <ID>
Argument / flagNotesWhat
<id>requiredThe hosted scenario to copy
--dataset DATASET_IDThe dataset to copy into. Default: the scenario's own, else your default dataset
--name NAMEThe copy's name. Default: "<name> (copy)", or "(copy 2)", ... when taken

simforge scenarios create

Create a hosted scenario from a recording or a template on a map

simforge scenarios create [OPTIONS] --map <MAP> --name <NAME>
Argument / flagNotesWhat
--log LOGA recording (simforge.recording/v1, or a simforge.log-scene/v1 file), JSON or gzipped
--template TEMPLATEA scenario template, instantiated at a site of the map
--map MAPrequiredThe map: a map version id, a map name or name@vN
--site SITEThe site to instantiate a template at; absent, its own pin or the first intent-preserving match
--seed SEEDsimulation.seed of the instantiated scenario
--name NAMErequiredThe new scenario's name
--max-cost CENTSExplicit maximum cloud cost in cents; required for billable cloud jobs
--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 scenarios list

List the hosted scenarios of your workspace

simforge scenarios list [OPTIONS]
Argument / flagNotesWhat
--limit LIMITAt most this many items
--status STATUSOnly items in this status
--type TYPEOnly items of this type

simforge scenarios show

One hosted scenario and its revisions

simforge scenarios show [OPTIONS] <ID>
Argument / flagNotesWhat
<id>requiredThe id