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

# CONFIG

> Manage local CLI configuration and named profiles

| Command                             | Description                                                                 |
| ----------------------------------- | --------------------------------------------------------------------------- |
| [`describe`](#describe)             | Describe each settable config key: meaning, default, env var, valid values. |
| [`get`](#get)                       | Print the value of a single config key from the active profile.             |
| [`init`](#init)                     | Create a commented config-file template for the active profile.             |
| [`list`](#list)                     | Show every config key in the active profile with its current value.         |
| [`path`](#path)                     | Print the absolute path of the config file in use; exit 1 if none exists.   |
| [`profile add`](#profile-add)       | Create a new, empty profile in the config file.                             |
| [`profile list`](#profile-list)     | List every profile in the config file, flagging which one is active.        |
| [`profile remove`](#profile-remove) | Remove a named profile from the config file.                                |
| [`profile use`](#profile-use)       | Switch the active profile by rewriting default\_profile in the config file. |
| [`set`](#set)                       | Set a config key in the active profile, persisting it to the config file.   |
| [`unset`](#unset)                   | Remove a key from the active profile (clean no-op if the key is not set).   |

***

## DESCRIBE

Describe each settable config key: meaning, default, env var, valid values.

```bash theme={null}
oumi-cli config describe [OPTIONS]
```

***

## GET

Print the value of a single config key from the active profile.

```bash theme={null}
oumi-cli config get [OPTIONS] [key]
```

**Arguments**

| Argument | Type | Required | Description                                                                                                       |
| -------- | ---- | -------- | ----------------------------------------------------------------------------------------------------------------- |
| `KEY`    | str  |          | Config key to read from the active profile. Valid keys: api\_base\_url, log\_level, org\_id, output, project\_id. |

***

## INIT

Create a commented config-file template for the active profile.

```bash theme={null}
oumi-cli config init [OPTIONS]
```

**Options**

| Option    | Type | Required | Description                                     |
| --------- | ---- | -------- | ----------------------------------------------- |
| `--force` | flag |          | Overwrite the config file if it already exists. |

***

## LIST

Show every config key in the active profile with its current value.

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

***

## PATH

Print the absolute path of the config file in use; exit 1 if none exists.

```bash theme={null}
oumi-cli config path [OPTIONS]
```

***

## PROFILE ADD

Create a new, empty profile in the config file.

```bash theme={null}
oumi-cli config profile add [OPTIONS] {name}
```

**Arguments**

| Argument | Type | Required | Description                    |
| -------- | ---- | -------- | ------------------------------ |
| `NAME`   | str  | ✓        | Name of the profile to create. |

**Options**

| Option  | Type | Required | Description                                              |
| ------- | ---- | -------- | -------------------------------------------------------- |
| `--use` | flag |          | Also switch the active profile to the newly created one. |

***

## PROFILE LIST

List every profile in the config file, flagging which one is active.

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

***

## PROFILE REMOVE

Remove a named profile from the config file.

```bash theme={null}
oumi-cli config profile remove [OPTIONS] {name}
```

**Arguments**

| Argument | Type | Required | Description                    |
| -------- | ---- | -------- | ------------------------------ |
| `NAME`   | str  | ✓        | Name of the profile to remove. |

**Options**

| Option    | Type | Required | Description                                                |
| --------- | ---- | -------- | ---------------------------------------------------------- |
| `--force` | flag |          | Allow removing the profile even if it is currently active. |

***

## PROFILE USE

Switch the active profile by rewriting default\_profile in the config file.

```bash theme={null}
oumi-cli config profile use [OPTIONS] {name}
```

**Arguments**

| Argument | Type | Required | Description                              |
| -------- | ---- | -------- | ---------------------------------------- |
| `NAME`   | str  | ✓        | Name of an existing profile to activate. |

***

## SET

Set a config key in the active profile, persisting it to the config file.

```bash theme={null}
oumi-cli config set [OPTIONS] [key] [value]
```

**Arguments**

| Argument | Type | Required | Description                                                                              |
| -------- | ---- | -------- | ---------------------------------------------------------------------------------------- |
| `KEY`    | str  |          | Config key to set. Valid keys: api\_base\_url, log\_level, org\_id, output, project\_id. |
| `VALUE`  | str  |          | New value for the key (run `config describe` for keys with constrained values).          |

***

## UNSET

Remove a key from the active profile (clean no-op if the key is not set).

```bash theme={null}
oumi-cli config unset [OPTIONS] [key]
```

**Arguments**

| Argument | Type | Required | Description                                                                                                         |
| -------- | ---- | -------- | ------------------------------------------------------------------------------------------------------------------- |
| `KEY`    | str  |          | Config key to remove from the active profile. Valid keys: api\_base\_url, log\_level, org\_id, output, project\_id. |

***