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

# AUTH

> Sign in to Oumi and check your authentication status

| Command             | Description                                                                  |
| ------------------- | ---------------------------------------------------------------------------- |
| [`login`](#login)   | Validate an API key against the server, then persist it for future commands. |
| [`logout`](#logout) | Remove any saved API key from the active profile's config.                   |
| [`status`](#status) | Show whether an API key is configured and verify it with the API.            |

***

## LOGIN

Validate an API key against the server, then persist it for future commands.

```bash theme={null}
oumi-cli auth login [OPTIONS]
```

**Options**

| Option           | Type | Required | Description                                                                                                                        |
| ---------------- | ---- | -------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `--api-key`      | str  |          | API key value to validate and persist (mutually exclusive with `--api-key-file`). Omit both to be prompted interactively on a TTY. |
| `--api-key-file` | path |          | Path to a file containing the API key to validate and persist (use - for stdin). Mutually exclusive with `--api-key`.              |

***

## LOGOUT

Remove any saved API key from the active profile's config.

```bash theme={null}
oumi-cli auth logout [OPTIONS]
```

***

## STATUS

Show whether an API key is configured and verify it with the API.

```bash theme={null}
oumi-cli auth status [OPTIONS]
```

***