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

# HARNESSES

> Register the agent endpoints that run rollouts during evaluation and synthesis

| Command | Description |
| - | - |
| [`create`](#create) | Register a harness: the HTTPS endpoint that runs a model's rollouts. |
| [`delete`](#delete) | Permanently delete a harness. |
| [`get`](#get) | Show one harness's endpoint, auth, and protocol version. |
| [`list`](#list) | List the harnesses a project has registered. |
| [`update`](#update) | Rename a harness or replace its credential. |

***

## CREATE

Register a harness: the HTTPS endpoint that runs a model's rollouts.

```bash theme={null}
oumi-cli harnesses create [OPTIONS]
```

**Options**

| Option | Type | Required | Description |
| - | - | - | - |
| `--project` | str | | Project that owns the harness; falls back to OUMI\_PROJECT\_ID or the active profile. |
| `--display-name` | str | ✓ | Display name for the harness. |
| `--endpoint-url` | str | ✓ | Public HTTPS base URL of the harness's endpoint. |
| `--auth` | choice | | How the endpoint authenticates calls. Omit for no auth. One of: `bearer`, `api-key`. |
| `--token-file` | path | | Path to a file holding the token (use - for stdin). Required with `--auth`. |
| `--header-name` | str | | Header the token is sent in, such as x-api-key. Required with `--auth` api-key. |
| `--scheme` | str | | Scheme sent before the token, as 'Authorization: \<scheme> \<token>' (the server defaults to Bearer). Only with `--auth` bearer. |

***

## DELETE

Permanently delete a harness.

```bash theme={null}
oumi-cli harnesses delete [OPTIONS] {harness_id}
```

**Arguments**

| Argument | Type | Required | Description |
| - | - | - | - |
| `HARNESS_ID` | int | ✓ | ID of the harness (see `oumi-cli harnesses list`). |

**Options**

| Option | Type | Required | Description |
| - | - | - | - |
| `--project` | str | | Project that owns the harness; falls back to OUMI\_PROJECT\_ID or the active profile. |
| `--force` | flag | | Skip the confirmation prompt. Without a TTY or under `--no-input`, this (or `--yes`) is required; otherwise the command exits 2 without changing anything. |
| `--yes` | flag | | Same as `--force`. |

***

## GET

Show one harness's endpoint, auth, and protocol version.

```bash theme={null}
oumi-cli harnesses get [OPTIONS] {harness_id}
```

**Arguments**

| Argument | Type | Required | Description |
| - | - | - | - |
| `HARNESS_ID` | int | ✓ | ID of the harness (see `oumi-cli harnesses list`). |

**Options**

| Option | Type | Required | Description |
| - | - | - | - |
| `--project` | str | | Project that owns the harness; falls back to OUMI\_PROJECT\_ID or the active profile. |

***

## LIST

List the harnesses a project has registered.

```bash theme={null}
oumi-cli harnesses list [OPTIONS]
```

**Options**

| Option | Type | Required | Description |
| - | - | - | - |
| `--project` | str | | Project to list harnesses from; falls back to OUMI\_PROJECT\_ID or the active profile. |
| `--limit` | int range | | Maximum number of harnesses to return (default 100). |
| `--all` | flag | | Return all harnesses, following pages until none are left (capped by `--max-items`). Cannot be combined with `--limit`. |
| `--max-items` | int range | | Cap on how many harnesses `--all` returns (default 10000). |
| `--sort-by` | choice | | Sort by creation time or last-update time. One of: `created_at`, `updated_at`. |
| `--sort-direction` | choice | | Ascending or descending order for `--sort-by`. |

***

## UPDATE

Rename a harness or replace its credential.

```bash theme={null}
oumi-cli harnesses update [OPTIONS] {harness_id}
```

**Arguments**

| Argument | Type | Required | Description |
| - | - | - | - |
| `HARNESS_ID` | int | ✓ | ID of the harness (see `oumi-cli harnesses list`). |

**Options**

| Option | Type | Required | Description |
| - | - | - | - |
| `--project` | str | | Project that owns the harness; falls back to OUMI\_PROJECT\_ID or the active profile. |
| `--display-name` | str | | New display name for the harness. |
| `--auth` | choice | | Type of the new credential, which replaces the stored one. One of: `bearer`, `api-key`. |
| `--token-file` | path | | Path to a file holding the token (use - for stdin). Required with `--auth`. |
| `--header-name` | str | | Header the token is sent in, such as x-api-key. Required with `--auth` api-key. |
| `--scheme` | str | | Scheme sent before the token, as 'Authorization: \<scheme> \<token>' (the server defaults to Bearer). Only with `--auth` bearer. |

***


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