> ## 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 preview

> Reference for simforge preview: 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).

## preview clip

A short clip of a scenario from --at for --seconds (MP4), locally or with --cloud

```sh theme={null}
simforge preview clip [OPTIONS] --out <OUT> <TARGET> [EXTRA]...
```

| Argument / flag | Notes | What |
| - | - | - |
| `<target>` | required | Scenario JSON file or materialized workspace; identical input for local and cloud |
| `<extra>` | repeatable | Runtime-specific options; forwarded without shell interpolation |
| `--out OUT` | required | Output file (PNG for a frame, MP4 for a clip) |
| `--mode MODE` | one of 2d, schematic, 3d; default 2d | `2d` (top-down map video on the CPU), `schematic` (the flat OpenDRIVE view, GPU) or `3d` (photoreal camera sensors, GPU) |
| `--rig RIG` | | Sensor rig JSON (`simforge rig init`). Default: the `basic-dash-camera` rig on the ego |
| `--camera CAMERA` | | The rig camera to look through |
| `--at AT` | default 0 | Scenario time in seconds |
| `--seconds SECONDS` | | Clip length in seconds |
| `--preset PRESET` | one of training, showcase, schematic | Render preset |
| `--force` | | Overwrite an existing output file |
| `--max-cost CENTS` | | Explicit maximum cloud cost in cents; required for billable cloud jobs |
| `--revision REVISION` | | Immutable revision for an existing hosted scenario target |
| `--stage` | | With --cloud: save a scenario file to the workspace as an immutable revision (free) and price the preview on it; starts nothing. --dry-run saves nothing |
| `--wait` | | Wait for a submitted cloud job to finish |
| `--download` | | Download a succeeded cloud job into --out; implies --wait |
| `--map-dir DIR` | | Render on this native map directory (`.corpus/<map>`) instead of the installed map found by content |
| `--ego ACTOR_ID` | | The 2D camera's ego actor; otherwise the workspace or scenario selects it |
| `--textures TEXTURES` | one of uastc-full, bc7-512 | The staged texture tier of a photoreal preview (as `render --textures`). Default: uastc-full |

## preview frame

One still frame of a scenario at --at seconds (PNG), locally or with --cloud

```sh theme={null}
simforge preview frame [OPTIONS] --out <OUT> <TARGET> [EXTRA]...
```

| Argument / flag | Notes | What |
| - | - | - |
| `<target>` | required | Scenario JSON file or materialized workspace; identical input for local and cloud |
| `<extra>` | repeatable | Runtime-specific options; forwarded without shell interpolation |
| `--out OUT` | required | Output file (PNG for a frame, MP4 for a clip) |
| `--mode MODE` | one of 2d, schematic, 3d; default 2d | `2d` (top-down map video on the CPU), `schematic` (the flat OpenDRIVE view, GPU) or `3d` (photoreal camera sensors, GPU) |
| `--rig RIG` | | Sensor rig JSON (`simforge rig init`). Default: the `basic-dash-camera` rig on the ego |
| `--camera CAMERA` | | The rig camera to look through |
| `--at AT` | default 0 | Scenario time in seconds |
| `--seconds SECONDS` | | Clip length in seconds |
| `--preset PRESET` | one of training, showcase, schematic | Render preset |
| `--force` | | Overwrite an existing output file |
| `--max-cost CENTS` | | Explicit maximum cloud cost in cents; required for billable cloud jobs |
| `--revision REVISION` | | Immutable revision for an existing hosted scenario target |
| `--stage` | | With --cloud: save a scenario file to the workspace as an immutable revision (free) and price the preview on it; starts nothing. --dry-run saves nothing |
| `--wait` | | Wait for a submitted cloud job to finish |
| `--download` | | Download a succeeded cloud job into --out; implies --wait |
| `--map-dir DIR` | | Render on this native map directory (`.corpus/<map>`) instead of the installed map found by content |
| `--ego ACTOR_ID` | | The 2D camera's ego actor; otherwise the workspace or scenario selects it |
| `--textures TEXTURES` | one of uastc-full, bc7-512 | The staged texture tier of a photoreal preview (as `render --textures`). Default: uastc-full |


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