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:Install script (macOS, Linux)
Run the following to download the latest release, verify the SHA-256 checksum, and install theomni binary to /usr/local/bin (or ~/.local/bin if /usr/local/bin is not writable):
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 theomni binary somewhere on your PATH.
Build from source
./bin/omni.
Staying up to date
In an interactive terminal, the CLI checks for a newer release in the background and prints a notice after a command succeeds. Builds from source aren’t checked, because they aren’t tagged releases. Check explicitly with:brew update && brew upgrade omni, re-running the install script, or downloading the new archive from the Releases page. See update notices for how the automatic check behaves and how to turn it off.
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:
Next steps
- Follow the CLI quickstart to configure your profile and authenticate with OAuth or an API token
- Use the commands reference to explore available commands