simforge authoring

Reference for simforge authoring: 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.

authoring capabilities

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

simforge authoring capabilities [OPTIONS]

authoring catalogue

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

simforge authoring catalogue [OPTIONS]

authoring discover

One page of map discovery without the map package: locations, lanes, movements or the actor catalogue

simforge authoring discover [OPTIONS] --map <MAP_VERSION_ID> --kind <KIND>

Argument / flag	Notes	What
--map MAP_VERSION_ID	required	The exact map version to look up (maps list names them)
--kind KIND	required; one of locations, lanes, movements, catalogue	lanes, movements (junction connectors), locations (crosswalks, junctions, …) or catalogue (built-in actors)
--limit N	default 20	Records per page (1 to 100)
--near X,Z		Nearest first from this scene point, metres (x east, z minus north); not with —kind catalogue
--within-m M		Only records within this many metres of —near (> 0)
--road ROAD_ID		Only records on this OpenDRIVE road: its lanes, movements entering, leaving or on it, locations anchored on it; not with —kind catalogue
--type TYPE	one of junction, junction_movement, driving_corridor, bike_corridor, walking_corridor, midblock_segment, merge_zone, lane_drop, parking_lane, parking_space, parking_area, parking_access_point, driveway, loading_zone, bus_stop, crosswalk, sidewalk, curb, median, refuge_island, building_entrance, school_zone, work_zone_suitable, occlusion_zone, conflict_zone, poi_frontage, address	Only locations of this type (with —kind locations)
--cursor CURSOR		The previous page’s nextCursor, with the same —map, —kind and filters

authoring operations

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

simforge authoring operations [OPTIONS] [OP_ID]

Argument / flag	Notes	What
<op_id>		One operation id (camelCase or its kebab-case command); absent, every operation

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 / flag	Notes	What
--map MAP_VERSION_ID	required	The exact map version to place on
--catalog-id ID	required	The actor’s catalog id (authoring discover --kind catalogue)
--lane-rsl RSL		A lane handle from authoring discover --kind lanes (with —s)
--s S		Metres along the lane from its start (with —lane-rsl)
--x X		A scene point (with —z)
--z Z		The scene point’s z in metres (with —x)
--heading-rad HEADING_RAD		The heading in radians in the scene frame. Default: the lane’s direction
--lateral-m LATERAL_M		Sideways offset from the lane centre in metres (positive left)
--opposing		Face against the lane’s direction
--static		Place a parked (static) actor
--draft DRAFT_ID		Check overlap against this draft’s actors (needs —expected-version and —expected-digest)
--expected-version N		The draftVersion of the receipt the check is based on (with —draft)
--expected-digest SHA256		The contentDigest of the receipt the check is based on (with —draft)