Omni CLI
Product · Developer tool · Engineering & development by Omni
Manage your Omni instance and automate data workflows from the terminal.
A terminal-based developer tool for managing Omni instances, querying data via natural language, and automating analytics workflows through APIs and CI/CD pipelines.
Category: Developer Tools
- Editors and tools
- Claude Code, Cursor, Codex, and terminal environments
- Installation Methods
- Homebrew, Install Script, GitHub Releases
- Authentication Type
- OAuth 2.1, API Key
- Default Output Format
- Human-readable terminal text
- Piped Output Format
- JSON
- Prompt Character Limit
- 400,000 characters for Omni Agent interactions
- Manage models, views, fields, and branches from the terminal
- Generate AI-powered queries from natural language prompts
- Automate workflows with shell scripts and CI/CD pipelines
- Open-source API wrapper for human and agent-friendly use
Overview
Omni CLI is a terminal-based developer tool designed for data engineers and administrators to manage Omni instances programmatically. It serves as an open-source wrapper for Omni's REST APIs, allowing users to query data, manage models, and administer users without leaving the command line. The tool supports natural language to SQL conversion, enabling the generation of AI-powered queries from simple prompts. It is built to be both human-friendly for interactive terminal use and agent-friendly for integration with AI coding assistants like Cursor and Claude Code. By supporting JSON output and scriptable commands, it facilitates the automation of model validation and deployment within CI/CD pipelines.
Data and Model Operations
- Semantic Layer Querying: Users can execute queries against the semantic layer directly from the terminal.
- Model Management: The CLI provides commands to manage models, views, fields, topics, and branches.
- Content Administration: Users can create, update, and organize documents, dashboards, and folders programmatically.
- Data Uploads: The tool supports uploading CSV and Excel files directly to the Omni instance.
Platform Administration
- User Management: Administrators can manage users, groups, and permissions through terminal commands.
- Schedule Automation: The CLI allows for the management and automation of data schedules.
- Connection Configuration: Commands are available to configure and manage connection environments.
- Identity Verification: The tool includes a 'whoami' command to verify current authentication and user context.
Developer Experience and Automation
- AI-Powered Queries: The CLI can generate AI-powered queries from natural language prompts.
- CI/CD Integration: Users can automate workflows, model validation, and deployments with shell scripts or CI/CD pipelines.
- API Wrapper: The CLI serves as an open-source wrapper for Omni's suite of REST APIs.
Use cases
- Data engineers automate model validation and deployment by integrating CLI commands into CI/CD pipelines.
- Administrators manage large sets of users and permissions programmatically using shell scripts.
- Developers use natural language prompts within the terminal to generate and test complex data queries.
- Analytics teams upload CSV and Excel files to their data warehouse directly from their local environment.
Specifications
- Editors and tools
- Claude Code, Cursor, Codex, and terminal environments
- Deployment
- Local terminal installation connecting to Omni cloud instances
- Installation Methods
- Homebrew, Install Script, GitHub Releases
- Authentication Type
- OAuth 2.1, API Key
- Default Output Format
- Human-readable terminal text
- Piped Output Format
- JSON
- Prompt Character Limit
- 400,000 characters for Omni Agent interactions
- Supported Environments
- Terminal, CI/CD, AI Coding Assistants
How it works
- Installation: Install the CLI using Homebrew, the official install script, or by downloading from GitHub releases.
- Authentication: Connect to your Omni instance using either OAuth for a streamlined setup or an API key for automated workflows.
- Quickstart Configuration: Configure a profile and run your first commands to query data or manage models.
FAQ
How do I install the Omni CLI?
The CLI can be installed via Homebrew, a curl-based install script, or directly from GitHub releases.
What authentication methods are supported?
The CLI supports two authentication methods: OAuth (which is recommended) and API keys for manual or automated workflows.
What output formats does the CLI support?
By default, it prints human-readable text to the terminal, but it automatically switches to JSON when output is piped or redirected.
Can I use the Omni CLI with AI coding agents?
Yes, the CLI is designed to be agent-friendly and can be used within AI coding assistants like Claude Code, Cursor, and Codex.
Added by AntSpace from public sources (docs.omni.co).