> ## 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

<Tabs>
  <Tab title="Homebrew">
    ```bash theme={null}
    brew install coval-ai/tap/coval
    ```
  </Tab>

  <Tab title="Cargo">
    ```bash theme={null}
    cargo install coval
    ```

    Requires [Rust](https://rustup.rs/) to be installed.
  </Tab>

  <Tab title="Binary">
    Download pre-built binaries from [GitHub Releases](https://github.com/coval-ai/cli/releases).
  </Tab>
</Tabs>

Verify your installation:

```bash theme={null}
coval --help
```

## 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.
</Warning>

### 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
```

### 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
```

### Config File Format

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

```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