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

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

## rig capabilities

Print the generated native camera declaration; support tiers do not imply device qualification

```sh theme={null}
simforge rig capabilities [OPTIONS]
```

## rig consumer-schema

Print the v2 consumer acquisition sidecar schema; timestamps are scheduled render instants

```sh theme={null}
simforge rig consumer-schema [OPTIONS]
```

## rig consumer-video-schema

Print the legacy v1 consumer video sidecar schema, which has no acquisition timestamps

```sh theme={null}
simforge rig consumer-video-schema [OPTIONS]
```

## rig effective-config

Resolve camera identity and required features without executing a renderer

```sh theme={null}
simforge rig effective-config [OPTIONS] <RIG.JSON>
```

| Argument / flag | Notes | What |
| - | - | - |
| `<rig.json>` | required | The `simforge.render-rig/v1` file |
| `--require CAMERA.FEATURE` | repeatable | Require a camera feature; repeat for each requirement. Unsupported combinations fail closed |

## rig init

Write a built-in rig, fitted to a carrier class's default box or as calibrated on one vehicle, as a `simforge.render-rig/v1` file

```sh theme={null}
simforge rig init [OPTIONS] --preset <PRESET> --out <FILE>
```

| Argument / flag | Notes | What |
| - | - | - |
| `--preset PRESET` | required; one of basic-dash-camera, tesla-hw3, waymo-5th-gen, surround-7cam-1lidar, roof-8cam-6lidar-4radar, alpamayo-2cam, alpamayo-4cam, alpamayo-6cam, alpamayo-6cam-vqa, front-4cam-wide-cross-tele, physicalai-av-7cam, drone-inspection-wide, drone-inspection-wide-zoom, drone-mapping-nadir, drone-fpv-forward, qwen-drive-3cam | The built-in rig |
| `--class CLASS` | one of car, truck, van, drone; default car | The carrier class whose default box the mounts are fitted to: car, truck or van for a road rig, drone for a drone rig; a calibrated rig takes only its own class |
| `--profile PROFILE` | one of training, showcase | The render profile whose capture (size and frame rate) every camera of a fitted rig records, showcase when omitted; a calibrated rig records its native capture and refuses one |
| `--actor ID` | default ego | The actor named in the file (every source's `actorId`); a render re-hosts a placeholder on the scenario's ego and refuses a file naming another of its roles |
| `--out FILE` | required | Where to write the rig |
| `--force` | | Overwrite an existing file |

## rig reported-schema

Print the reported-only calibration JSON Schema; hash integrity is checked by the consumer parser

```sh theme={null}
simforge rig reported-schema [OPTIONS]
```

## rig schema

Print the Platform-generated render-rig/v1 JSON Schema; cross-field checks also run in validate

```sh theme={null}
simforge rig schema [OPTIONS]
```

## rig show

What a rig captures: each source's mount, the way it faces and its field of view, and the cameras' horizontal coverage; the installed runtime shows a rig with a camera lens

```sh theme={null}
simforge rig show [OPTIONS] <RIG.JSON>
```

| Argument / flag | Notes | What |
| - | - | - |
| `<rig.json>` | required | A `simforge.render-rig/v1` file |

## rig validate

Check a `simforge.render-rig/v1` file as a render reads it; the installed runtime plans a camera lens (cameraModel). Exit 2 with the finding

```sh theme={null}
simforge rig validate [OPTIONS] <RIG.JSON>
```

| Argument / flag | Notes | What |
| - | - | - |
| `<rig.json>` | required | A `simforge.render-rig/v1` file |


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