Docs menu

// Command reference

simforge world

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

Serve a persistent local realtime world and its authenticated drive/state endpoints

simforge world serve [OPTIONS] --map <MAP> --token-file <TOKEN_FILE>
Argument / flagNotesWhat
--map MAPrequiredThe installed map to serve (its name or directory)
--scenario SCENARIOA scenario file whose actors start in the world
--seed SEEDThe seed for traffic population and every seeded draw
--pacing PACINGone of realtime, fast, pausedrealtime advances at 50 Hz wall clock, fast unpaced, paused only on world.time.advanceTicks
--socket SOCKETThe Unix socket (named pipe on Windows) to serve runtime protocol v1 on
--listen LISTENA loopback HOST:PORT for the authenticated /commands and /truth WebSocket endpoints
--token-file TOKEN_FILErequiredA mode-0600 file of 32-512 bytes holding the host token clients authenticate with
--vehicles VEHICLESHow many population vehicles to keep in the world
--pedestrians PEDESTRIANSHow many population pedestrians to keep in the world
--record RECORDRecord the session as a simforge.recording/v1 file here
--journal-dir JOURNAL_DIRThe durable journal directory (command log segments and checkpoints)
--ready-file READY_FILEAlso write the readiness JSON to this file
--restore RESTORERestore a host checkpoint (*.host-checkpoint.msgpack) at launch
--cache-root CACHE_ROOTMap cache root to search. Default: SIMFORGE_MAPS_CACHE_ROOT, then $XDG_DATA_HOME/simforge/maps
--allow-no-collidersServe a map that ships no colliders (actors can then pass through static geometry)
--allow-origin ALLOW_ORIGINrepeatableExplicit browser origins allowed by the closed host (repeatable)