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 pip
      • Installation with Docker
  • Core Concepts
    • Agent
      • Intercept Modes
        • Mocking
        • Recording
      • Lifecycle Hooks
      • Proxy Settings
        • Data Rules
        • Firewall Rules
        • Rewrite Rules
        • Matching Rules
    • Context
    • Mock API
      • Request
        • Response
        • Replay History
      • Scenarios
      • Snapshots
    • Scaffold
      • Validation
  • 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 Mock APIs
      • How to Mock Requests
        • Mocking from the UI
        • Mocking from the CLI
      • How to Create Scenarios
        • Creating from the UI
        • Creating from the CLI
      • How to Snapshot Requests
        • Deleting Snapshots
        • Sharing Snapshots
      • How to Create Lifecycle Hooks
        • Setting Credentials
        • Setting Responses
      • How to Update Requests
        • Editing from the UI
        • Editing with Snapshots
        • Replaying from the UI
        • Replaying from the CLI
        • Updating with Open API
      • How to Update Scenarios
        • Updating from the UI
        • Updating from the CLI
      • How to Create Contexts
    • How to Replay Requests
      • Replay with the UI
      • Replay with the CLI
    • How to Integrate E2E Testing
      • How to Scaffold an App
      • How to Scaffold a Service
      • How to Run a Workflow
        • Running with CLI command
        • Running with Make
      • How to Stop a Workflow
        • Stopping with CLI command
        • Stopping with Make
      • How to Customize a Workflow
        • Adding Custom Container Services
        • Adding Custom Lifecycle Hooks
        • Adding Custom Init Scripts
        • Adding Custom Configure Scripts
      • How to Validate a Workflow
  • 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
  • Update
  • Verify
  • Next Steps

Was this helpful?

  1. Getting Started
  2. Installing the Agent

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 the official installation steps or run the following commands:

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

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

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

Verify

stoobly-agent --help

Next Steps

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

PreviousInstalling the AgentNextInstallation with Docker

Last updated 25 days ago

Was this helpful?

How to Record Requests
How to Integrate E2E Testing