Docs menu

// Command reference

simforge authoring

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

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 / flagNotesWhat
--map MAP_VERSION_IDrequiredThe exact map version to look up (maps list names them)
--kind KINDrequired; one of locations, lanes, movements, cataloguelanes, movements (junction connectors), locations (crosswalks, junctions, ...) or catalogue (built-in actors)
--limit Ndefault 20Records per page (1 to 100)
--near X,ZNearest first from this scene point, metres (x east, z minus north); not with --kind catalogue
--within-m MOnly records within this many metres of --near (> 0)
--road ROAD_IDOnly records on this OpenDRIVE road: its lanes, movements entering, leaving or on it, locations anchored on it; not with --kind catalogue
--type TYPEone 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, addressOnly locations of this type (with --kind locations)
--cursor CURSORThe previous page's nextCursor, with the same --map, --kind and filters

simforge 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 / 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_IDrequiredThe exact map version to place on
--catalog-id IDrequiredThe actor's catalog id (authoring discover --kind catalogue)
--lane-rsl RSLA lane handle from authoring discover --kind lanes (with --s)
--s SMetres along the lane from its start (with --lane-rsl)
--x XA scene point (with --z)
--z ZThe scene point's z in metres (with --x)
--heading-rad HEADING_RADThe heading in radians in the scene frame. Default: the lane's direction
--lateral-m LATERAL_MSideways offset from the lane centre in metres (positive left)
--opposingFace against the lane's direction
--staticPlace a parked (static) actor
--draft DRAFT_IDCheck overlap against this draft's actors (needs --expected-version and --expected-digest)
--expected-version NThe draftVersion of the receipt the check is based on (with --draft)
--expected-digest SHA256The contentDigest of the receipt the check is based on (with --draft)