Skip to main content
Using a coding agent? Paste this prompt into Claude Code, Cursor, Codex, or any coding agent and it will install the Omni CLI for you:
The Omni CLI lets you manage your Omni instance from the terminal. Use it to query data, manage models and content, administer users and permissions, and automate workflows with scripts or CI/CD pipelines.

​
What you can do

  • Run queries against your semantic layer
  • Manage models, views, fields, topics, and branches
  • Create, update, and organize documents, dashboards, and folders
  • Manage users, groups, permissions, and schedules
  • Generate AI-powered queries from natural language
  • Upload CSV and Excel files
  • Automate any of the above with shell scripts or CI/CD

​
Get started

Install

Install the CLI via Homebrew, an install script, or GitHub releases.

Authenticate

Connect using OAuth (recommended) or an API key.

Quickstart

Configure a profile and run your first commands.
Once the CLI is installed, you can use Omni’s agent skills to bring analytics capabilities directly into AI coding assistants like Claude Code, Cursor, and Codex.

​
Output

By default, commands print human-readable output on a terminal and JSON when piped or redirected. Errors go to stderr; local usage errors use plain text even in JSON mode. See errors and exit codes for details. Override the default with:
  • --format json — force JSON output even on a terminal
  • --compact — print non-indented JSON, useful for piping to tools like jq
See output formats for details.

​
Available commands

See the Commands reference for the complete list of CLI commands.

​
Contributing

Contributions to the Omni CLI are welcome. Open a pull request or file an issue in the GitHub repository.