CLI

The Coval CLI provides terminal access to Coval’s evaluation APIs for scripting, automation, and CI/CD integration.

GitHub Repository

View source, releases, and contribute

Quick Start

Install the CLI

brew install coval-ai/tap/coval

See Installation for all methods.

Authenticate

coval login

Launch an evaluation

coval runs launch \
  --agent-id <agent_id> \
  --persona-id <persona_id> \
  --test-set-id <test_set_id>

Watch progress

coval runs watch <run_id>

Command Reference

Agents

Create, list, update, and delete agent configurations

Runs

Launch evaluations and monitor progress in real time

Simulations

Inspect individual simulation results and download audio

Conversations

Inspect monitored conversations, audio, and metric results

Test Sets

Organize test cases into collections

Test Cases

Define inputs and expected outputs for evaluations

Personas

Configure simulated callers with voice and language settings

Metrics

Define how simulations are scored and evaluated

Mutations

Test agent variations with config overrides

API Keys

Manage API keys for programmatic access

Run Templates

Save reusable evaluation configurations

Scheduled Runs

Schedule recurring evaluation runs

Dashboards

Create dashboards and widgets for monitoring

Global Flags

All commands support these flags:

Flag	Description	Default
`--format <format>`	Output format: `table` or `json`	`table`
`--api-key <key>`	Override API key for this command	—
`--api-url <url>`	Override API base URL	—
`--help`	Show help for any command	—

JSON Output for Scripting

Use --format json to get machine-readable output:

# Get run status
coval runs get abc123 --format json | jq '.status'

# List agent IDs
coval agents list --format json | jq '.[].id'

# Extract simulation transcript
coval simulations get sim123 --format json | jq '.transcript'

Requirements

macOS, Linux, or Windows
Coval API key from Dashboard Settings

Getting Started

Resources

GitHub Repository

Quick Start

Command Reference

Agents

Runs

Simulations

Conversations

Test Sets

Test Cases

Personas

Metrics

Mutations

API Keys

Run Templates

Scheduled Runs

Dashboards

Global Flags

JSON Output for Scripting

Requirements

GitHub Repository

​Quick Start

​Command Reference

Agents

Runs

Simulations

Conversations

Test Sets

Test Cases

Personas

Metrics

Mutations

API Keys

Run Templates

Scheduled Runs

Dashboards

​Global Flags

​JSON Output for Scripting

​Requirements

Quick Start

Command Reference

Global Flags

JSON Output for Scripting

Requirements