Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.omni.co/llms.txt

Use this file to discover all available pages before exploring further.

​
Prerequisites

  • A supported OS:
    • macOS (amd64, arm64)
    • Linux (amd64, arm64)
    • Windows (amd64)
  • A terminal with permission to install binaries on your PATH

​
Homebrew (macOS, Linux) (preferred)

If you use Homebrew, install the CLI with: 
brew tap exploreomni/tap
brew install omni

​
Install script (macOS, Linux)

Run the following to download the latest release, verify the SHA-256 checksum, and install the omni binary to /usr/local/bin (or ~/.local/bin if /usr/local/bin is not writable): 
curl -fsSL https://raw.githubusercontent.com/exploreomni/cli/main/install.sh | sh

​
GitHub releases (macOS, Linux, Windows)

Pre-built binaries for macOS, Linux, and Windows are available in the CLI repository on the Releases page. Download the archive for your platform, extract it, and place the omni binary somewhere on your PATH.
PlatformArchitectures
macOSamd64, arm64
Linuxamd64, arm64
Windowsamd64

​
Build from source

git clone https://github.com/exploreomni/cli.git
cd cli
make build
The binary is written to ./bin/omni.

​
Troubleshooting

​
omni: command not found

The binary is likely installed outside your current PATH.
  • If installed to ~/.local/bin, add it to your shell profile.
  • Restart your terminal, then run omni --help.

​
Permission denied when installing

If you do not have write access to /usr/local/bin, use the install script. It automatically falls back to ~/.local/bin.

​
Homebrew cannot find omni

Re-run the tap command, then install again: 
brew tap exploreomni/tap
brew install omni

​
Next steps