// Command reference
simforge recording
Generated from the CLI's own help (CLI 0.2.0-rc.5). Global flags and exit codes are on the reference index.
simforge recording from-trace
Save a simulation's trace (a rollout) as a simforge.recording/v1 recording
simforge recording from-trace [OPTIONS] --out <FILE> --producer <PRODUCER> <TRACE|DIR>
Runs on: local runtime
| Argument / flag | Notes | What |
|---|---|---|
| <trace|dir> | required | The trace (trace.json[.gz]), or a workspace/package directory (its simulation/trace.json.gz) |
| --out FILE | required | The recording to write (gzipped canonical JSON; the conventional name is <sha256>.rec.json.gz) |
| --producer PRODUCER | required | The producer recorded in source.producer (id and version) |
| --clip-ref CLIP_REF | default | An opaque reference to the rollout (source.clipRef) |
| --license LICENSE | The licence of the rollout's inputs, when it carries one | |
| --ego EGO | The ego actor id (default: the trace's metricSubject) | |
| --map-version MAP_VERSION | The map release version the trace ran on (map.version), when known |
simforge recording inspect
Read a recording through the contract: its digest, map, size and lineage
simforge recording inspect [OPTIONS] <RECORDING>
Runs on: local runtime
| Argument / flag | Notes | What |
|---|---|---|
| <recording> | required | The recording (simforge.recording/v1 or log-scene/v1, optionally gzipped) |
simforge recording scaffold
A registered recording as a scenario package that carries no simulation: the scaffolded scenario, the recording it pins and the report of the operation that made it
simforge recording scaffold [OPTIONS] --map <DIR|NAME@VERSION> --out <DIR> <RECORDING>
Runs on: local runtime
| Argument / flag | Notes | What |
|---|---|---|
| <recording> | required | The recording (simforge.recording/v1 or log-scene/v1, optionally gzipped); registered on the map |
| --map DIR|NAME@VERSION | required | The map the recording was registered on: a map directory, or name[@version] under the maps cache (semantic profile) |
| --out DIR | required | The package directory to write (created; must be empty if it exists) |
| --title NAME | The scenario's name (meta.name; default "<producer> <clipRef>") | |
| --report REPORT.JSON | The report the recording's derivedFrom.reportSha256 names, packaged byte for byte (transfer-report.json or import-report.json, by its schema) | |
| --cache-root DIR | Map cache root to search for NAME@VERSION. Default: SIMFORGE_MAPS_CACHE_ROOT, then $XDG_DATA_HOME/simforge/maps | |
| --assets-root DIR | Actor-asset root whose closure restricts catalog binding to renderable models. Default: SIMFORGE_ACTOR_ASSETS_ROOT, then $XDG_DATA_HOME/simforge/actor-assets | |
| --actor-closure SHA256 | The actor closure the package pins (default: this CLI's pinned public closure) |