Skip to main content

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.

​
Installation

brew install coval-ai/tap/coval
Verify your installation: 
coval --help

​
Authentication

​
Interactive Login

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:
VariableDescription
COVAL_API_KEYAPI key (overrides config file)
COVAL_API_URLAPI base URL (overrides config file)
# 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