Installation with pip

How to use pip to install Stoobly

Our official Python support is 3.10, 3.11, and 3.12.

Prerequisite

We will use pipx to install the agent. To install pipx, either follow their official installation steps or run the following commands:

To install pipx for a specific Python version (e.g. Python 3.10) then change the python3 command to python3.10

macOS

brew install pipx
pipx ensurepath

Ubuntu

python3 -m pip install --user pipx
python3 -m pipx ensurepath

You may need to start a new terminal session after

Install

To install the agent, run:

pipx install stoobly-agent

This will use pipx to download the agent from our PyPI Python Package Index.

Update

To update the agent, run:

pipx upgrade stoobly-agent

Run

To start the agent, run:

stoobly-agent run

The above command will expose the proxy on port 8080 and the UI on port 4200

• If the proxy port conflicts, configure it with the --proxy-port INTEGER flag

• If the UI port conflicts, configure it with --ui-port INTEGER flag

Then you should see output similar to this to indicate that the agent started up successfully:

UI server listening at http://0.0.0.0:4200

INFO:root:app.settings.reload_settings
INFO:root:app.settings.reload_settings
Loading script /home/user/.local/lib/python3.8/site-packages/stoobly_agent/app/proxy/intercept_handler.py
Proxy server listening at http://*:8080

For macOS users, because stoobly-agent is a proxy server, you might be prompted to accept incoming network connections . Click "Allow".