CONFIG

Command	Description
`describe`	Describe each settable config key: meaning, default, env var, valid values.
`get`	Print the value of a single config key from the active profile.
`init`	Create a commented config-file template for the active profile.
`list`	Show every config key in the active profile with its current value.
`path`	Print the absolute path of the config file in use; exit 1 if none exists.
`profile add`	Create a new, empty profile in the config file.
`profile list`	List every profile in the config file, flagging which one is active.
`profile remove`	Remove a named profile from the config file.
`profile use`	Switch the active profile by rewriting default_profile in the config file.
`set`	Set a config key in the active profile, persisting it to the config file.
`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.

oumi-cli config describe [OPTIONS]

GET

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

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.

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.

oumi-cli config list [OPTIONS]

PATH

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

oumi-cli config path [OPTIONS]

PROFILE ADD

Create a new, empty profile in the config file.

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.

oumi-cli config profile list [OPTIONS]

PROFILE REMOVE

Remove a named profile from the config file.

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.

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.

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

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.

Getting started

Basics

Workflows

Command reference

DESCRIBE

GET

INIT

LIST

PATH

PROFILE ADD

PROFILE LIST

PROFILE REMOVE

PROFILE USE

SET

UNSET

​DESCRIBE

​GET

​INIT

​LIST

​PATH

​PROFILE ADD

​PROFILE LIST

​PROFILE REMOVE

​PROFILE USE

​SET

​UNSET

DESCRIBE

GET

INIT

LIST

PATH

PROFILE ADD

PROFILE LIST

PROFILE REMOVE

PROFILE USE

SET

UNSET