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

verial simulators list

List simulators visible to your organization. Supports cursor pagination and filtering by environment. Synopsis:
Options: Example:
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:
Options: Example:
REST equivalent: POST /simulators.

verial simulators get

Fetch a single simulator by ID or slug. Synopsis:
Example:
REST equivalent: GET /simulators/:id.

verial simulators update

Update a simulator’s name, description, or config. Omitted fields are left unchanged. Synopsis:
Example:
REST equivalent: PATCH /simulators/:id.

verial simulators delete

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

Next Steps

Simulators

Simulator types and config shape.

Sandboxes

Provision a running simulator instance.