Skip to main content

​
Requirements

To follow the steps in this guide, you’ll need an Omni account. The CLI can authenticate with OAuth (recommended) or an API key. See CLI authentication for details on both methods.

​
Steps

1

Install the CLI

See the CLI installation guide.
2

Configure a profile

After you install the CLI, run:
omni config init
This creates a profile with your organization, API endpoint, and authentication method. You can create multiple profiles for different organizations or environments.
3

Authenticate

Recommended: OAuthRun the following command and authorize in your browser:
omni config login
Alternative: API keyEither enter your API token during config init, or set the environment variable:
export OMNI_API_TOKEN=omni_osk_...
See CLI authentication for more details on both methods.
4

Run a command

omni models list
omni documents list
omni --help

​
Next steps