Skip to content

Installation

  • Python 3.9+
  • Bash 3.2+ (macOS default is fine)
  • gh CLI (for GitHub operations — optional but recommended)
  • pyyaml (installed automatically with the CLI package)

uv is the fastest way to install OACP:

Terminal window
uv tool install oacp-cli

If you prefer pipx:

Terminal window
pipx install oacp-cli

You can run OACP commands without a permanent install using uvx:

Terminal window
uvx --from oacp-cli oacp doctor

This downloads the package into a temporary environment, runs the command, and cleans up. Useful for trying OACP before committing to an install.

For development or to run the latest unreleased version:

Terminal window
git clone https://github.com/kiloloop/oacp.git
cd oacp
uv tool install .

Confirm that the CLI is installed and your environment is healthy:

Terminal window
oacp --version

Then run the built-in health check:

Terminal window
oacp doctor

oacp doctor verifies that Python, Bash, required packages, and directory permissions are all set up correctly. If anything is misconfigured, it reports what to fix.

Once installed, follow the Quick Start to initialize your first project and send a message.