CLI Installation & Auth

The omni CLI provides command-line access to the Omni platform, allowing you to run agent sessions, inspect usage, verify credentials, and check system health directly from your terminal.

Installation

npm install -g @omni-os/cli

Authentication & Credential Storage

The CLI resolves credentials using the following precedence order:

1. OMNI_API_KEY environment variable (highest priority)
2. Local config file: ~/.omni/config.json

Logging In

Store your API key securely into local configuration:

omni auth login --key omni_sk_live_1234567890abcdef...

[!SECURITY] Filesystem Permissions: The configuration file ~/.omni/config.json is created with strict 0600 (read/write by owner only) permissions. Never commit or expose your config directory.

Verifying Identity

Check which account and scopes are active:

omni auth whoami

Output:

Authenticated as: usr_94a645d99c3a
Key Prefix:       omni_sk_live_1234...
Scopes:           chat, memory:read, memory:write, usage:read
Status:           Valid