Skip to content

Installation Guide

OpenJarvis CLI can be installed as an isolated Python application from PyPI using uv or pip, run using pre-built standalone binaries (zero Python required), or run directly from source.


Option 1: Via PyPI (uv / pip / pipx)

OpenJarvis CLI is distributed on PyPI as openjarvis-cli.

uv installs openjarvis into an isolated tool environment and places the executable on your PATH:

uv tool install openjarvis-cli

To run OpenJarvis or its short alias:

openjarvis
# or:
oj

To upgrade to the latest release:

uv tool upgrade openjarvis-cli

Using pipx

pipx install openjarvis-cli

Using standard pip

pip install openjarvis-cli

Option 2: Standalone Binary (Zero Python Required)

Pre-built binaries include all dependencies and embedded documentation. No Python runtime or build tools are required.

Download

Download the release archive for your operating system and architecture from GitHub Releases: - Linux (x86_64): openjarvis-v0.3.2-linux-x86_64.tar.gz - macOS (Apple Silicon arm64): openjarvis-v0.3.2-macos-arm64.tar.gz - Windows (x86_64): openjarvis-v0.3.2-windows-x86_64.zip

Linux & macOS

# 1. Extract the release tarball
tar xzf openjarvis-*.tar.gz
cd openjarvis-*

# 2. Make executable if needed
chmod +x openjarvis

# 3. Launch OpenJarvis
./openjarvis

# (Optional) Install system-wide
sudo mv openjarvis /usr/local/bin/

Windows

  1. Extract the ZIP archive.
  2. Open PowerShell or Command Prompt in the extracted directory.
  3. Run .\openjarvis.exe.

Option 3: Running from Source with uv

If you are developing or prefer running directly from the git repository:

# Clone the repository
git clone https://github.com/bhanuponguru/openjarvis-cli.git
cd openjarvis-cli

# Install dependencies and launch
uv sync --group dev --group docs --group build
uv run openjarvis

Next Steps