Skip to main content
The verial environments commands manage 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 ahead of a benchmark run. Authentication is required. See verial auth.

​
Subcommands

CommandDescription
verial environments listList environments in your organization.
verial environments createCreate a new environment.
verial environments getGet a single environment by ID.
verial environments updateUpdate an environment’s name or description.
verial environments deleteDelete an environment.
verial environments create-playgroundInstantiate an environment as a live playground.

​
verial environments list

List environments visible to your organization. Supports cursor pagination. Synopsis: 
verial environments list [--cursor <cursor>] [--limit <n>]
Options:
FlagDescriptionDefault
--cursor <cursor>Pagination cursor returned from a prior page.—
--limit <limit>Items per page.Server default
Example: 
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.

​
verial environments create

Create an empty environment. Add simulators through the REST API or dashboard after creation. Synopsis: 
verial environments create --name <name> [--description <desc>]
Options:
FlagDescriptionRequired
--name <name>Environment name.Yes
--description <desc>Free-text description.No
Example: 
verial environments create --name "Cardiology Practice" --description "Ambulatory cardiology clinic"
REST equivalent: POST /environments.

​
verial environments get

Fetch a single environment, including its simulators. Synopsis: 
verial environments get --id <id>
Example: 
verial environments get --id env_clxyz123
REST equivalent: GET /environments/:id.

​
verial environments update

Update an environment’s name or description. Omitted fields are left unchanged. Synopsis: 
verial environments update --id <id> [--name <name>] [--description <desc>]
Example: 
verial environments update --id env_clxyz123 --name "Primary Care - West"
REST equivalent: PATCH /environments/:id.

​
verial environments delete

Delete an environment. Playgrounds already provisioned from it are not torn down. Synopsis: 
verial environments delete --id <id>

Deleted env_clxyz123
REST equivalent: DELETE /environments/:id.

​
verial environments create-playground

Provision a Playground from an environment: create the FHIR store, lease phone numbers, and load seed data. Synopsis: 
verial environments create-playground --id <id>
Example: 
verial environments create-playground --id env_clxyz123

​
Next Steps

Environments

Environment model and simulator types.

Environments API

Full REST parameters and response schema.