Skip to main content
This guide installs the Omni CLI, sets up a profile, authenticates, and runs your first commands.

​
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; OAuth requires an Organization Admin to have enabled Personal Access Tokens first. 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:
This creates a profile with a name, an API endpoint, and an authentication method. You can create multiple profiles for different organizations or environments.
3

Authenticate

Choose one of the following authentication methods:
Run the following command and authorize in your browser:
See CLI authentication for more details on both methods.
4

Run your first commands

  • omni whoami whoami (yes, whoami twice: it’s the whoami command group’s own whoami subcommand) confirms your identity, key scope, and permissions without changing anything. It’s a good first call after authenticating.
  • omni models list lists the models you can query.
  • omni documents list lists the workbooks and dashboards you can access.
  • omni --help lists every available command group.

​
Next steps