Documentation Index
Fetch the complete documentation index at: https://docs.coval.dev/llms.txt
Use this file to discover all available pages before exploring further.
List Simulations
coval simulations list [OPTIONS]
| Option | Type | Default | Description |
|---|
--filter | string | — | Filter expression |
--run-id | string | — | Filter by run ID |
--page-size | number | 50 | Results per page |
--order-by | string | — | Sort order |
# List all simulations
coval simulations list
# Filter by run
coval simulations list --run-id run_abc123
# Combine filters
coval simulations list --filter 'status="COMPLETED"' --run-id run_abc123
Get Simulation
coval simulations get <simulation_id>
| Argument | Type | Required | Description |
|---|
simulation_id | string | Yes | The simulation ID |
coval simulations get sim_abc123
Download Audio
Download or get the audio URL for a simulation recording.
coval simulations audio <simulation_id> [OPTIONS]
| Argument | Type | Required | Description |
|---|
simulation_id | string | Yes | The simulation ID |
| Option | Type | Description |
|---|
-o, --output | string | File path to save audio |
# Print audio URL
coval simulations audio sim_abc123
# Download audio file
coval simulations audio sim_abc123 -o recording.wav
-o, a progress bar shows the download status.
List Metrics
List all metric results for a simulation.
coval simulations metrics <simulation_id>
| Argument | Type | Required | Description |
|---|
simulation_id | string | Yes | The simulation ID |
coval simulations metrics sim_abc123
Get Metric Detail
Retrieve metric results for a simulation. The second argument accepts two ID types and the output adapts accordingly:
- 26-char MetricOutput ULID — prints one row (the specific output).
- 22-char Metric definition ID — prints every output recorded for that metric on the simulation.
coval simulations metric-detail <simulation_id> <id>
| Argument | Type | Required | Description |
|---|
simulation_id | string | Yes | The simulation ID |
id | string | Yes | Either a 26-char MetricOutput ULID or a 22-char Metric definition ID |
coval simulations metric-detail sim_abc123 01ARZ3NDEKTSV4RRFFQ69G5FAV
coval simulations metric-detail sim_abc123 29BlkepvvX19ebbLDB0y6Q
Delete Simulation
coval simulations delete <simulation_id>
| Argument | Type | Required | Description |
|---|
simulation_id | string | Yes | The simulation ID to delete |
Simulation Statuses
| Status | Description |
|---|
PENDING | Simulation is created but not yet started |
IN_QUEUE | Simulation is queued for execution |
IN_PROGRESS | Simulation is actively running |
COMPLETED | Simulation finished successfully |
FAILED | Simulation encountered an error |
CANCELLED | Simulation was cancelled |
DELETED | Simulation was deleted |
When using --filter, use the underscore-separated enum values (e.g., status="IN_PROGRESS").
