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

# verial simulators

> Create, inspect, and manage simulators from the command line.

The `verial simulators` commands manage [Simulators](/api-reference/resources/simulators) — the simulated entities (FHIR store, voice line, payer portal, fax endpoint, etc.) that live inside an [Environment](/api-reference/resources/environments). Use them to script simulator lifecycle in CI alongside your agent code.

Authentication is required. See [verial auth](/cli/auth).

## Subcommands

| Command                    | Description                                        |
| -------------------------- | -------------------------------------------------- |
| `verial simulators list`   | List simulators in your organization.              |
| `verial simulators create` | Create a new simulator of a given type.            |
| `verial simulators get`    | Get a single simulator by ID or slug.              |
| `verial simulators update` | Update a simulator's name, description, or config. |
| `verial simulators delete` | Delete a simulator.                                |

## verial simulators list

List simulators visible to your organization. Supports cursor pagination and filtering by environment.

Synopsis:

```bash theme={null}
verial simulators list [--environment-id <id>] [--cursor <cursor>] [--limit <n>]
```

Options:

| Flag                    | Description                                           | Default        |
| ----------------------- | ----------------------------------------------------- | -------------- |
| `--environment-id <id>` | Only return simulators belonging to this environment. | —              |
| `--cursor <cursor>`     | Pagination cursor returned from a prior page.         | —              |
| `--limit <limit>`       | Items per page.                                       | Server default |

Example:

```bash theme={null}
verial simulators list --environment-id env_clxyz123 --limit 10
```

REST equivalent: [GET /simulators](/api-reference/resources/simulators).

## verial simulators create

Create a simulator. `--type` is validated against the SDK's `SimulatorType` enum: one of `FHIR`, `HL7`, `CDSHooks`, `Voice`, `Fax`, `SFTP`, `Email`, `Message`, `Payer`, `Clearinghouse`.

Synopsis:

```bash theme={null}
verial simulators create --type <type> --name <name> [--description <desc>] [--config <json>]
```

Options:

| Flag                   | Description                         | Required |
| ---------------------- | ----------------------------------- | -------- |
| `--type <type>`        | Simulator type (see enum above).    | Yes      |
| `--name <name>`        | Simulator name.                     | Yes      |
| `--description <desc>` | Free-text description.              | No       |
| `--config <json>`      | Inline JSON config (type-specific). | No       |

Example:

```bash theme={null}
verial simulators create \
  --type Payer \
  --name "CoverMyMeds" \
  --config '{"portal":"covermymeds"}'
```

REST equivalent: [POST /simulators](/api-reference/resources/simulators).

## verial simulators get

Fetch a single simulator by ID or slug.

Synopsis:

```bash theme={null}
verial simulators get --id <id>
```

Example:

```bash theme={null}
verial simulators get --id sim_clxyz789
```

REST equivalent: [GET /simulators/:id](/api-reference/resources/simulators).

## verial simulators update

Update a simulator's name, description, or config. Omitted fields are left unchanged.

Synopsis:

```bash theme={null}
verial simulators update --id <id> [--name <name>] [--description <desc>] [--config <json>]
```

Example:

```bash theme={null}
verial simulators update --id sim_clxyz789 --config '{"portal":"covermymeds"}'
```

REST equivalent: [PATCH /simulators/:id](/api-reference/resources/simulators).

## verial simulators delete

Delete a simulator. Sandboxes already provisioned from it are not torn down automatically.

Synopsis:

```bash theme={null}
verial simulators delete --id <id>
```

REST equivalent: [DELETE /simulators/:id](/api-reference/resources/simulators).

## Next Steps

<CardGroup cols={2}>
  <Card title="Simulators" icon="plug" href="/api-reference/resources/simulators">
    Simulator types and config shape.
  </Card>

  <Card title="Sandboxes" icon="box" href="/cli/sandboxes">
    Provision a running simulator instance.
  </Card>
</CardGroup>