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

> Create, inspect, and instantiate environments from the command line.

The `verial environments` commands manage [Environments](/api-reference/resources/environments) — reusable simulated health system definitions that contain simulators (FHIR, voice, patient, HL7, X12, fax). Use them to script environment setup in CI or to spin up a [Playground](/api-reference/resources/playgrounds) ahead of a benchmark run.

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

## Subcommands

| Command                                 | Description                                      |
| --------------------------------------- | ------------------------------------------------ |
| `verial environments list`              | List environments in your organization.          |
| `verial environments create`            | Create a new environment.                        |
| `verial environments get`               | Get a single environment by ID.                  |
| `verial environments update`            | Update an environment's name or description.     |
| `verial environments delete`            | Delete an environment.                           |
| `verial environments create-playground` | Instantiate an environment as a live playground. |

## verial environments list

List environments visible to your organization. Supports cursor pagination.

Synopsis:

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

Options:

| Flag                | Description                                   | Default        |
| ------------------- | --------------------------------------------- | -------------- |
| `--cursor <cursor>` | Pagination cursor returned from a prior page. | —              |
| `--limit <limit>`   | Items per page.                               | Server default |

Example:

```bash theme={null}
verial environments list --limit 10
```

```
ID                  NAME                     CREATED
env_clxyz123        Primary Care Clinic      4/15/2026, 10:12:04 AM
env_clxyz456        Cardiology Practice      4/20/2026, 2:31:18 PM
```

REST equivalent: [GET /environments](/api-reference/environments/list).

## verial environments create

Create an empty environment. Add simulators through the REST API or dashboard after creation.

Synopsis:

```bash theme={null}
verial environments create --name <name> [--description <desc>]
```

Options:

| Flag                   | Description            | Required |
| ---------------------- | ---------------------- | -------- |
| `--name <name>`        | Environment name.      | Yes      |
| `--description <desc>` | Free-text description. | No       |

Example:

```bash theme={null}
verial environments create --name "Cardiology Practice" --description "Ambulatory cardiology clinic"
```

REST equivalent: [POST /environments](/api-reference/environments/create).

## verial environments get

Fetch a single environment, including its simulators.

Synopsis:

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

Example:

```bash theme={null}
verial environments get --id env_clxyz123
```

REST equivalent: [GET /environments/:id](/api-reference/environments/get).

## verial environments update

Update an environment's name or description. Omitted fields are left unchanged.

Synopsis:

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

Example:

```bash theme={null}
verial environments update --id env_clxyz123 --name "Primary Care - West"
```

REST equivalent: [PATCH /environments/:id](/api-reference/environments/update).

## verial environments delete

Delete an environment. Playgrounds already provisioned from it are not torn down.

Synopsis:

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

```
Deleted env_clxyz123
```

REST equivalent: [DELETE /environments/:id](/api-reference/environments/delete).

## verial environments create-playground

Provision a [Playground](/api-reference/resources/playgrounds) from an environment: create the FHIR store, lease phone numbers, and load seed data.

Synopsis:

```bash theme={null}
verial environments create-playground --id <id>
```

Example:

```bash theme={null}
verial environments create-playground --id env_clxyz123
```

## Next Steps

<CardGroup cols={2}>
  <Card title="Environments" icon="hospital" href="/api-reference/resources/environments">
    Environment model and simulator types.
  </Card>

  <Card title="Environments API" icon="code" href="/api-reference/environments/list">
    Full REST parameters and response schema.
  </Card>
</CardGroup>