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

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

## runtime install

Download and install the closed runtime (PolyForm Noncommercial 1.0.0) after accepting its license and SimForge's account and download terms

```sh theme={null}
simforge runtime install [OPTIONS]
```

| Argument / flag | Notes | What |
| - | - | - |
| `--target TARGET` | default host target | The platform to download for (a Rust target triple). Default: this machine's |
| `--version VERSION` | | The exact runtime release to install. Default: the one this CLI pins |
| `--root ROOT` | | Where to install the runtime. Default: SIMFORGE\_RUNTIME\_ROOT, then the root of the last install, then \<data home>/simforge/runtime. The root is recorded in the CLI config, so `runtime status`, `doctor` and every local command find it; the download and its unpacking stay inside it |
| `--for LEVEL` | one of 2d, 3d | What to install the runtime for: `2d` (authoring, simulation and 2D renders: the runtime without the 3D actor models and sky, about 1/30 of the download) or `3d` (also local 3D renders). Default: what is installed, else `2d` |
| `--accept-license` | | Explicitly accept the current license and terms (agreement version and SHA) before downloading |

## runtime license

Read the runtime license (PolyForm Noncommercial 1.0.0) and SimForge's account and download terms without accepting them

```sh theme={null}
simforge runtime license [OPTIONS]
```

## runtime status

Report the installed runtime's protocol and engine identity; `--available` also lists what `runtime install` would download, with sizes

```sh theme={null}
simforge runtime status [OPTIONS]
```

| Argument / flag | Notes | What |
| - | - | - |
| `--available` | | Also list the runtime releases this account can install for this machine (`2d`, `3d`), each with its version, download and installed size; works before any runtime is installed |


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