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
          • Customizing Container Services
          • Customizing Lifecycle Hooks
          • Customizing Init Scripts
          • Customizing Configure Scripts
          • Customizing Makefile
        • 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
      • How to Update a Scaffold
        • Deleting a Service
      • 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
  • Proxy Server
  • Web Interface
  • Command-Line Interface

Was this helpful?

  1. Core Concepts

Agent

Overview of Stoobly agent (stoobly-agent)

PreviousInstallation with DockerNextIntercept Modes

Last updated 3 months ago

Was this helpful?

Stoobly agent is a that can intercept HTTP(s) requests to use for recording, mocking and replaying.

It is made of three main components:

  • A proxy server

  • A dashboard web interface

  • A command-line interface

Proxy Server

The proxy server is an extension of the open-source project.

Web Interface

The web UI can be used to create, view, update and delete requests and scenarios. It also has convenient buttons and drop-downs to change the agent mode to configure when you want to mock or record requests. Finally, it also provides an easy way to modify the proxy configuration for customizing rewrite and match rules.

Command-Line Interface

The CLI is ideal for using Stoobly as part of scripts and CI pipelines. To see what the CLI offers:

$ stoobly-agent                                                                                                                                                                                                                          10s
Usage: stoobly-agent [OPTIONS] COMMAND [ARGS]...

Options:
  --version   Show the version and exit.
  -h, --help  Show this message and exit.

Commands:
  dev-tools  Access developer tools
  exec       Run shell command with proxy enabled
  feature    Manage features
  init       Initialize a new context
  mock       Mock request
  record     Record request

Proxy Commands:
  ca-cert    Manage CA certificate
  config     Manage proxy config
  intercept  Manage request intercept
  run        Run proxy and/or UI

Local Resource Commands:
  request    Manage requests
  scenario   Manage request scenarios

  Run 'stoobly-agent COMMAND --help' for more information on a command.

man-in-the-middle proxy
mitmproxy