Skip to main content
The verial simulators commands manage Simulators — the simulated entities (FHIR store, voice line, payer portal, fax endpoint, etc.) that live inside an Environment. Use them to script simulator lifecycle in CI alongside your agent code. Authentication is required. See verial auth.

​
Subcommands

CommandDescription
verial simulators listList simulators in your organization.
verial simulators createCreate a new simulator of a given type.
verial simulators getGet a single simulator by ID or slug.
verial simulators updateUpdate a simulator’s name, description, or config.
verial simulators deleteDelete a simulator.

​
verial simulators list

List simulators visible to your organization. Supports cursor pagination and filtering by environment. Synopsis: 
verial simulators list [--environment-id <id>] [--cursor <cursor>] [--limit <n>]
Options:
FlagDescriptionDefault
--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: 
verial simulators list --environment-id env_clxyz123 --limit 10
REST equivalent: GET /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: 
verial simulators create --type <type> --name <name> [--description <desc>] [--config <json>]
Options:
FlagDescriptionRequired
--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: 
verial simulators create \
  --type Payer \
  --name "CoverMyMeds" \
  --config '{"portal":"covermymeds"}'
REST equivalent: POST /simulators.

​
verial simulators get

Fetch a single simulator by ID or slug. Synopsis: 
verial simulators get --id <id>
Example: 
verial simulators get --id sim_clxyz789
REST equivalent: GET /simulators/:id.

​
verial simulators update

Update a simulator’s name, description, or config. Omitted fields are left unchanged. Synopsis: 
verial simulators update --id <id> [--name <name>] [--description <desc>] [--config <json>]
Example: 
verial simulators update --id sim_clxyz789 --config '{"portal":"covermymeds"}'
REST equivalent: PATCH /simulators/:id.

​
verial simulators delete

Delete a simulator. Sandboxes already provisioned from it are not torn down automatically. Synopsis: 
verial simulators delete --id <id>
REST equivalent: DELETE /simulators/:id.

​
Next Steps

Simulators

Simulator types and config shape.

Sandboxes

Provision a running simulator instance.