Skip to content

Installation Guide

Complete guide to install Omni CLI on any platform.

Table of Contents

System Requirements

  • Python: 3.10 or higher
  • Operating System: macOS, Linux, or Windows
  • Disk Space: ~50 MB minimum
  • RAM: 512 MB minimum (for CLI operations)

Install from PyPI

The easiest and recommended way to install Omni CLI:

pip install omni-cli

To install with development dependencies:

pip install "omni-cli[dev]"

pipx installs Python CLI tools in isolated environments:

# Install pipx if you don't have it
pip install pipx
pipx ensurepath

# Install Omni CLI
pipx install omni-cli

Install from Source

For development or to get the latest unreleased features:

# Clone the repository
git clone https://github.com/mateussiqueira/omni-cli.git
cd omni-cli

# Create a virtual environment
python3 -m venv .venv

# Activate the environment
# macOS/Linux:
source .venv/bin/activate
# Windows:
.venv\Scripts\activate

# Install in development mode
pip install -e ".[dev]"

Install on macOS

Using Homebrew (when available)

brew install omni-cli

Using pip

python3 -m pip install omni-cli

For Apple Silicon (M1/M2/M3)

Omni CLI works natively on Apple Silicon. If you encounter architecture issues, ensure you are using the arm64 version of Python:

python3 -c "import platform; print(platform.machine())"
# Should output: arm64

Install on Linux

Using pip

python3 -m pip install omni-cli

Using your distribution's package manager (when available)

# Ubuntu/Debian (when .deb is available)
sudo dpkg -i omni-cli_0.1.0_amd64.deb

# Fedora/RHEL (when .rpm is available)
sudo rpm -i omni-cli-0.1.0.x86_64.rpm

Install on Windows

Using pip

python -m pip install omni-cli

Using pipx

pip install pipx
pipx ensurepath
pipx install omni-cli

After installation, you may need to restart your terminal or PowerShell session.

Verify Installation

Run the following commands to verify the installation:

# Check version
omni --version

# Check status
omni status

# Show help
omni --help

Expected output for version:

Omni CLI 0.1.0

Upgrade

To upgrade to the latest version:

pip install --upgrade omni-cli

Or with pipx:

pipx upgrade omni-cli

Uninstall

To remove Omni CLI:

pip uninstall omni-cli

Or with pipx:

pipx uninstall omni-cli

Post-Installation

After installing, run the interactive configuration:

omni config init

This will guide you through setting up: - Hostinger API token - GitHub token and username - Unleash URL and token - Thunderbolt SSD path - MCP config path

Next Steps