Docs menu

// Command reference

simforge authoring

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 authoring capabilities

What this credential may do on this host: operation, host-operation, feature and worker status

simforge authoring capabilities [OPTIONS]

simforge authoring catalogue

The host's operation catalogue (simforge.authoring-operations/v1)

simforge authoring catalogue [OPTIONS]

simforge authoring discover

Bounded map discovery without the map package: locations, lanes, movements or the actor catalogue

simforge authoring discover [OPTIONS] --map <MAP_VERSION_ID> --kind <KIND>
Argument / flagNotesWhat
--map MAP_VERSION_IDrequired
--kind KINDrequired; one of locations, lanes, movements, catalogue
--limit N

simforge authoring operations

Every operation with its drafts apply flags, result schema and the host's status for this credential

simforge authoring operations [OPTIONS] [OP_ID]
Argument / flagNotesWhat
<op_id>One operation id (camelCase or its kebab-case command); absent, every operation

simforge authoring spawn

Whether an actor can be placed at a lane position or scene point, optionally against a draft's actors

simforge authoring spawn [OPTIONS] --map <MAP_VERSION_ID> --catalog-id <ID>
Argument / flagNotesWhat
--map MAP_VERSION_IDrequired
--catalog-id IDrequired
--lane-rsl RSLA lane handle from authoring discover --kind lanes (with --s)
--s S
--x XA scene point (with --z)
--z Z
--heading-rad HEADING_RAD
--lateral-m LATERAL_M
--opposing
--static
--draft DRAFT_IDCheck overlap against this draft's actors (needs --expected-version and --expected-digest)
--expected-version N
--expected-digest SHA256