simforge scenarios

Reference for simforge scenarios: usage, arguments and flags, generated from the CLI.

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

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 / flag	Notes	What
<id>	required	The hosted scenario to copy
--dataset DATASET_ID		The dataset to copy into. Default: the scenario’s own, else your default dataset
--name NAME		The copy’s name. Default: “<name> (copy)”, or “(copy 2)”, … when taken

scenarios create

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

simforge scenarios create [OPTIONS] --map <MAP> --name <NAME>

Argument / flag	Notes	What
--log LOG		A recording (simforge.recording/v1, or a simforge.log-scene/v1 file), JSON or gzipped
--template TEMPLATE		A scenario template, instantiated at a site of the map
--map MAP	required	The map: a map version id, a map name or name@vN
--site SITE		The site to instantiate a template at; absent, its own pin or the first intent-preserving match
--seed SEED		simulation.seed of the instantiated scenario
--name NAME	required	The new scenario’s name
--max-cost CENTS		Explicit maximum cloud cost in cents; required for billable cloud jobs
--stage		With —log: upload the recording and price its import, starting nothing. —dry-run uploads nothing
--lidar-topic TOPIC		MCAP only: the lidar topic, when the log has several
--gnss-topic TOPIC		MCAP only: the GNSS topic, when the log has several
--ego-dims L,W,H	repeatable	MCAP only: the ego’s box in metres, length,width,height (perceive’s default otherwise)
--ego-rear-axle-to-centre METRES		MCAP only: how far the ego box’s centre is ahead of base_link (the rear axle), metres

scenarios list

List the hosted scenarios of your workspace

simforge scenarios list [OPTIONS]

Argument / flag	Notes	What
--limit LIMIT	default 20	At most this many items on the page
--cursor CURSOR		The next page: the nextCursor of the page before it

scenarios show

One hosted scenario and its revisions

simforge scenarios show [OPTIONS] <ID>

Argument / flag	Notes	What
<id>	required	The id