> ## Documentation Index
> Fetch the complete documentation index at: https://docs.simforge.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# simforge world

> Reference for simforge world: usage, arguments and flags, generated from the CLI.

Generated from the CLI's own help (CLI 0.2.0-rc.5). Global flags and exit codes are on the [command reference](/cli).

## world serve

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

```sh theme={null}
simforge world serve [OPTIONS] --map <MAP> --token-file <TOKEN_FILE>
```

| Argument / flag | Notes | What |
| - | - | - |
| `--map MAP` | required | The installed map to serve (its name or directory) |
| `--scenario SCENARIO` | | A scenario file whose actors start in the world |
| `--seed SEED` | | The seed for traffic population and every seeded draw |
| `--pacing PACING` | one of realtime, fast, paused | `realtime` advances at 50 Hz wall clock, `fast` unpaced, `paused` only on world.time.advanceTicks |
| `--socket SOCKET` | | The Unix socket (named pipe on Windows) to serve runtime protocol v1 on |
| `--listen LISTEN` | | A loopback HOST:PORT for the authenticated /commands and /truth WebSocket endpoints |
| `--token-file TOKEN_FILE` | required | A mode-0600 file of 32-512 bytes holding the host token clients authenticate with |
| `--vehicles VEHICLES` | | How many population vehicles to keep in the world |
| `--pedestrians PEDESTRIANS` | | How many population pedestrians to keep in the world |
| `--record RECORD` | | Record the session as a simforge.recording/v1 file here |
| `--journal-dir JOURNAL_DIR` | | The durable journal directory (command log segments and checkpoints) |
| `--ready-file READY_FILE` | | Also write the readiness JSON to this file |
| `--restore RESTORE` | | Restore a host checkpoint (`*.host-checkpoint.msgpack`) at launch |
| `--cache-root CACHE_ROOT` | | Map cache root to search. Default: SIMFORGE\_MAPS\_CACHE\_ROOT, then \$XDG\_DATA\_HOME/simforge/maps |
| `--allow-no-colliders` | | Serve a map that ships no colliders (actors can then pass through static geometry) |
| `--allow-origin ALLOW_ORIGIN` | repeatable | Explicit browser origins allowed by the closed host (repeatable) |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.