Docs menu

// Command reference

simforge timeline

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

Build the render timeline for a workspace's trace (deterministic, content-keyed)

simforge timeline build [OPTIONS] [WORKSPACE]

Runs on: local runtime

Argument / flagNotesWhat
<workspace>The workspace directory (an imported scenario package). Omit it and pass --trace instead
--trace FILEA trace file (JSON or gzip; any released trace format) instead of a workspace
--recorded-trace-sha256 SHA256The identity recorded next to the stored trace (bound to an upgraded trace; checked against a current one)
--catalog-digest SHA256Actor-catalog closure digest to key the timeline by (a workspace supplies its own)
--height HEIGHTone of auto, ground, flat; default autoThe height source
--flat-z METRESElevation of the plane for --height flat
--map-dir DIRUse this map directory (map.xodr + derived/ground/ground-mesh.bin) instead of the installed map found by content
--cache-root DIRMap cache root to search. Default: SIMFORGE_MAPS_CACHE_ROOT, then $XDG_DATA_HOME/simforge/maps
--out FILEWrite the canonical timeline here (.gz compresses). Default: the workspace's timeline/<sha256>.json; with --trace, nothing is written
--visual-dynamicsDerive each logged four-wheeler's body pitch and roll from its recorded track (log replays only; any other input is refused ego_visual_dynamics_input_invalid). The timeline key changes; without the flag the timeline is unchanged
--vd-rate-hz HZWith --visual-dynamics: the rate the log's poses were recorded at, Hz. Default: 50. A rate the poses contradict (a resampled lower-rate log declared higher) is refused, and so is a pose-only log below 10 Hz