Installation

How do I install stoobly-agent?

Option 1: Install with pipx (recommended)

Prerequisites:

• Python 3.10, 3.11, or 3.12

Install pipx:

macOS:

brew install pipx
pipx ensurepath
source ~/.bashrc

Linux:

python3 -m pip install --user pipx
python3 -m pipx ensurepath
source ~/.bashrc

Install stoobly-agent:

pipx install stoobly-agent --python python3

Verify:

stoobly-agent --help

More details: Installation with pipx

---

Option 2: Install with Docker

Prerequisites:

• Docker installed (official instructions)

Pull the image:

docker pull stoobly/agent

Verify:

docker run \
    -v ~/.stoobly:/home/stoobly/.stoobly \
    stoobly/agent \
    stoobly-agent --help

More details: Installation with Docker

---

How do I update stoobly-agent?

With pipx:

pipx upgrade stoobly-agent

With Docker:

docker pull stoobly/agent

---

What Python versions are supported?

Python 3.10, 3.11, and 3.12 are officially supported.

If you need to install a specific Python version, use pyenv:

pyenv install 3.12.3
pyenv local 3.12.3
export PATH="$HOME/.pyenv/bin:$PATH"
eval "$(pyenv init --path)"
eval "$(pyenv init -)"

---

How do I verify stoobly-agent is installed?

With pipx:

stoobly-agent --help

With Docker:

docker run \
    -v ~/.stoobly:/home/stoobly/.stoobly \
    stoobly/agent \
    stoobly-agent --help

---

Next Steps

After installation:

• API Mocking: How to Record Requests

• E2E Testing: How to Integrate E2E Testing