Docs menu

// Command reference

simforge log

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

Scaffold and compile a simforge.recording/v1 (or log-scene/v1) recording into a simulated, renderable workspace

simforge log import [OPTIONS] --map <DIR|NAME@VERSION> --out <DIR> <SCENE.JSON>

Runs on: local runtime

Argument / flagNotesWhat
<scene.json>requiredThe recording (simforge.recording/v1, or simforge.log-scene/v1; JSON, optionally gzipped)
--map DIR|NAME@VERSIONrequiredThe installed map: a map directory, or name[@version] under the maps cache (semantic profile)
--out DIRrequiredThe workspace to write (created; must be empty if it exists)
--mode MODEone of replay; default replay
--cache-root DIRMap cache root to search for NAME@VERSION. Default: SIMFORGE_MAPS_CACHE_ROOT, then $XDG_DATA_HOME/simforge/maps
--assets-root DIRActor-asset root whose closure restricts catalog binding to renderable models. Default: SIMFORGE_ACTOR_ASSETS_ROOT, then $XDG_DATA_HOME/simforge/actor-assets
--actor-closure SHA256The actor closure the workspace pins (default: this CLI's pinned public closure)
--allow-no-collidersSimulate without map colliders when the map publishes none (recorded; the default refuses)

simforge log import-many

Run many log import jobs in one process (each map's world loaded once); per job the same workspace and result

simforge log import-many [OPTIONS]

Runs on: local runtime

Argument / flagNotesWhat
--jobs JOBS.JSONThe jobs: {"jobs": [{"scene": SCENE.JSON, "map": DIR|NAME@VERSION, "out": DIR}, ...]}, run in order
--streamRead one job object per stdin line and write one result line per job to stdout as it ends (until EOF)
--mode MODEone of replay; default replay
--cache-root DIRMap cache root to search for NAME@VERSION. Default: SIMFORGE_MAPS_CACHE_ROOT, then $XDG_DATA_HOME/simforge/maps
--assets-root DIRActor-asset root whose closure restricts catalog binding to renderable models. Default: SIMFORGE_ACTOR_ASSETS_ROOT, then $XDG_DATA_HOME/simforge/actor-assets
--actor-closure SHA256The actor closure every workspace pins (default: this CLI's pinned public closure)
--allow-no-collidersSimulate without map colliders when the map publishes none (recorded; the default refuses)