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
  • Run

Was this helpful?

  1. Developer Guide

Installation from Source

PreviousFAQNextSubmitting Change Requests

Last updated 3 months ago

Was this helpful?

To contribute and submit changes to Stoobly, you must first install from the source code.

Prerequisite

Install with the following command:

curl -sSL https://install.python-poetry.org | python3 -
curl -sSL https://install.python-poetry.org | python3 -

Install

  1. Download the agent source code:

git clone https://github.com/Stoobly/stoobly-agent.git

  1. Change your directory to where you cloned it and run the install command:

poetry install

Run

To start the agent, run:

poetry 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 like this to indicate that it 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
poetry