Installation & Configuration

Installation

Homebrew
Build from source
Binary

brew install coval-ai/tap/coval

cargo install --git https://github.com/coval-ai/cli --locked

Requires Rust to be installed. The CLI is not published to crates.io; the official versioned artifacts are the Homebrew formula and the GitHub release binaries.

Verify your installation:

coval --help

Updates

The CLI checks for a newer release at most once per day and prints a one-line notice on stderr when one is available. The check never changes command output, exit codes, or behavior, and it is skipped entirely in agent mode. Set COVAL_NO_UPDATE_CHECK=1 to disable it.

# Upgrade a Homebrew install
brew upgrade coval-ai/tap/coval

Authentication

coval login

You will be prompted to enter your API key. Get one from Dashboard Settings.

API Key Flag

Pass your API key directly:

coval login --api-key sk_your_api_key

Passing API keys as command arguments can expose them in shell history and process lists. For CI/CD pipelines, prefer using the COVAL_API_KEY environment variable or your CI provider’s secret management instead.

Verify Authentication

coval whoami

Displays your masked API key (e.g., sk_...****) to confirm you are authenticated.

Configuration

The CLI stores configuration in a platform-specific config directory. Run coval config path to see the exact location on your system.

View Config Path

coval config path

Get a Config Value

coval config get api_key
coval config get api_url

Set a Config Value

coval config set api_key sk_your_api_key
coval config set api_url https://api.coval.dev

Config File Format

api_key = "sk_..."
api_url = "https://api.coval.dev"

Environment Variables

Environment variables override config file values:

Variable	Description
`COVAL_API_KEY`	API key (overrides config file)
`COVAL_API_URL`	API base URL (overrides config file)
`COVAL_NO_UPDATE_CHECK`	Set to any value to disable the daily update check

# Use in CI/CD pipelines
export COVAL_API_KEY=sk_your_api_key
coval runs launch --agent-id abc123 --persona-id xyz789 --test-set-id ts123

Supported Platforms

macOS (Intel and Apple Silicon)
Linux (x86_64)
Windows

Getting Started

Resources

Installation

Updates

Authentication

API Key Flag

Verify Authentication

Configuration

View Config Path

Get a Config Value

Set a Config Value

Config File Format

Environment Variables

Supported Platforms

​Installation

​Updates

​Authentication

​Interactive Login

​API Key Flag

​Verify Authentication

​Configuration

​View Config Path

​Get a Config Value

​Set a Config Value

​Config File Format

​Environment Variables

​Supported Platforms

Installation

Updates

Authentication

Interactive Login

API Key Flag

Verify Authentication

Configuration

View Config Path

Get a Config Value

Set a Config Value

Config File Format

Environment Variables

Supported Platforms