> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coval.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation & Configuration

> Install the Coval CLI and configure authentication

## Installation

> [tab] Homebrew
>
> ```bash theme={null}
> brew install coval-ai/tap/coval
> ```

> [tab] Build from source
>
> ```bash theme={null}
> cargo install --git https://github.com/coval-ai/cli --locked
> ```
>
> Requires [Rust](https://rustup.rs/) to be installed. The CLI is not published to crates.io; the official versioned artifacts are the Homebrew formula and the GitHub release binaries.

> [tab] Binary
>
> Download pre-built binaries from [GitHub Releases](https://github.com/coval-ai/cli/releases).

Verify your installation:

```bash theme={null}
coval --version
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](https://docs.coval.ai/cli/agent-mode.md). Set `COVAL_NO_UPDATE_CHECK=1` to disable it.

```bash theme={null}
# Refresh the tap and upgrade a Homebrew install
brew update
brew upgrade coval-ai/tap/coval
```

## Authentication

### Interactive Login

```bash theme={null}
coval login
```

You will be prompted to enter your API key. Get one from [Dashboard Settings](https://app.coval.dev/settings).

### API Key Flag

Pass your API key directly:

```bash theme={null}
coval login --api-key sk_your_api_key
```

> [!WARNING]
>
> 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

```bash theme={null}
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

```bash theme={null}
coval config path
```

### Get a Config Value

```bash theme={null}
coval config get api_key
coval config get api_url
coval config get workspace_id
```

### Set a Config Value

```bash theme={null}
coval config set api_key sk_your_api_key
coval config set api_url https://api.coval.dev
coval config set workspace_id 01HZXW6Q8V4M2R7N5K3J9T1BCD
```

### Config File Format

```toml theme={null}
api_key = "sk_..."
api_url = "https://api.coval.dev"
# Optional: run every command in this workspace
workspace_id = "01HZXW6Q8V4M2R7N5K3J9T1BCD"
```

## 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_WORKSPACE_ID` | Workspace to run commands in (overrides config file; the `--workspace` flag overrides it) |
| `COVAL_NO_UPDATE_CHECK` | Set to any value to disable the daily update check |

```bash theme={null}
# 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


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.