Install the CLI

In this page, you'll install the supyagent command-line tool and verify it's working.

Prerequisites

You need Python 3.11 or higher. Check your version:

python3 --version
# Python 3.11.x or higher

If you don't have Python 3.11+, install it from python.org or use your system's package manager.

Install supyagent

The recommended way is with pip:

pip install supyagent

If you use uv (a faster Python package manager):

uv pip install supyagent

Verify the installation

supyagent --version

You should see:

supyagent v0.6.2

(Your version number may be higher.)

Troubleshooting

`command not found: supyagent`

pip installed the package, but the supyagent command isn't in your PATH. Try:

# Option 1: Use python -m
python3 -m supyagent --version

# Option 2: Install with pipx (auto-manages PATH)
pipx install supyagent

# Option 3: Check where pip installed it
python3 -m site --user-base
# Add the bin/ subdirectory of that path to your PATH

`pip: command not found`

You may need to use pip3 instead of pip:

pip3 install supyagent

Or install pip:

python3 -m ensurepip --upgrade

`error: externally-managed-environment` (Debian/Ubuntu)

Recent Debian and Ubuntu versions prevent installing packages globally with pip. Use one of:

# Option 1: Use pipx
pipx install supyagent

# Option 2: Use uv
uv pip install supyagent

# Option 3: Use a virtual environment
python3 -m venv ~/.supyagent-venv
~/.supyagent-venv/bin/pip install supyagent
# Then add ~/.supyagent-venv/bin to your PATH

Next step

Connect Your Account — Link the CLI to your Supyagent dashboard account.

Install the CLI

On this page