Stoobly Docs
  • Introduction
  • Use Cases
    • Generate Mock APIs
      • Empower Development
      • Scale API Testing
    • Enable E2E Testing
  • FAQ
    • Recording
    • Mocking
    • Terminology
  • Getting Started
    • Installing the Agent
      • Installation with pipx
      • Installation with Docker
  • Core Concepts
    • Agent
      • Intercept Modes
        • Mocking
        • Recording
      • Lifecycle Hooks
      • Proxy Settings
        • Data Rules
        • Firewall Rules
        • Rewrite Rules
        • Match Rules
    • Context
    • Mock API
      • Request
        • Response
        • Replay History
      • Scenarios
      • Snapshots
      • Fixtures
      • Public Folder
    • Scaffold
      • Service
      • Validation
      • Workflow
  • Guides
    • How to Run the Agent
      • Run with CLI
      • Run with Docker
    • How to Configure the Agent
      • Forward Proxy
        • Enable HTTPS Traffic
      • Reverse Proxy
    • How to Record Requests
      • Recording from the UI
      • Recording from the CLI
      • How to Create Contexts
      • How to Create Scenarios
        • Creating from the UI
        • Creating from the CLI
      • How to Create Requests
      • How to Customize Recordings
        • Customizing with Lifecycle Hooks
    • How to Update Requests
      • Editing from the UI
      • Editing with Snapshots
      • How to Update Scenarios
        • Updating from the UI
        • Updating from the CLI
      • Updating with Replay
        • Replaying from the UI
        • Replaying from the CLI
        • How to Customize Replays
          • Customizing with Lifecycle Hooks
      • Updating with Open API
    • How to Mock APIs
      • How to Enable Mocking
        • Enabling from the UI
        • Enabling from the CLI
      • How to Snapshot Requests
        • Deleting Snapshots
        • Sharing Snapshots
      • How to Use Fixtures
      • How to Customize Mocking
        • Customizing with Lifecycle Hooks
        • Customizing with Request Headers
      • Troubleshooting
    • How to Replay Requests
      • Replay with the UI
      • Replay with the CLI
    • How to Integrate E2E Testing
      • How to Scaffold an App
        • Scaffolding a Service
        • Customizing a Workflow
          • Adding Custom Container Services
          • Adding Custom Lifecycle Hooks
          • Adding Custom Init Scripts
          • Adding Custom Configure Scripts
        • Updating a Scaffold Setup
        • Deleting a Service
        • Best Practices
        • Troubleshooting
      • How to Run a Workflow
        • Running with CLI command
        • Running with Make
        • Troubleshooting
          • Validating
      • How to Stop a Workflow
        • Stopping with CLI command
        • Stopping with Make
      • FAQ
  • Developer Guide
    • Installation from Source
    • Submitting Change Requests
    • Releases
  • Experimental
    • Experimental Features
      • Aliases
      • Endpoints
      • API Testing
        • Getting Started
        • Configuration
          • Assign
          • Lifecycle Hooks
          • Trace
      • Optional Components
Powered by GitBook
On this page
  • Prerequisite
  • Install supported Python version
  • Install pipx
  • Install
  • Update
  • Verify
  • Next Steps

Was this helpful?

  1. Getting Started
  2. Installing the Agent

Installation with pipx

How to use pip to install Stoobly

PreviousInstalling the AgentNextInstallation with Docker

Last updated 3 days ago

Was this helpful?

Prerequisite

Install supported Python version

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

If none of the supported Python versions are available on your system, you will need to install one using pyenv . Otherwise, skip to the next section.

To install a specific Python version, first install .

1

Install specific Python version

pyenv install 3.12.3
pyenv local 3.12.3
2

Switch Python version 

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

Install pipx

To install , either follow the or run the following commands:

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

Install

To install the agent, run:

pipx install stoobly-agent --python python3

This will use pipx to download the agent from our .

Update

To update the agent, run:

pipx upgrade stoobly-agent

Verify

stoobly-agent --help

Next Steps

You're all setup! Depending on your use case, you may want to take a look at:

pyenv
pipx
official installation steps
PyPI Python Package Index
How to Record Requests
How to Integrate E2E Testing