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
  • Prerequisites
  • Updating
  • Overwriting
  • Steps
  • Cleanup

Was this helpful?

  1. Guides
  2. How to Update Requests
  3. How to Update Scenarios

Updating from the CLI

PreviousUpdating from the UINextUpdating with Replay

Last updated 6 months ago

Was this helpful?

There are two ways to update a scenario using the CLI.

  • Replay a scenario's requests and update the request responses

  • Completely overwriting the scenario with new requests and responses

Prerequisites

  1. Go through the main guide:

Updating

This is preferable if only the response of one or more requests changed.

The following command will replay the scenario and update the recorded responses with the newly received repsonses.

stoobly-agent scenario replay --overwrite <SCENARIO-KEY>

Overwriting

This is preferable if anything other than the request response changed.

The following will overwite the scenario with newly recorded requests and their respective responses.

Steps

stoobly-agent config scenario set <SCENARIO_KEY>
  1. Set the Agent to record mode with overwrite policy.

stoobly-agent intercept configure --mode record --policy overwrite
  1. Enable request interception with the Agent.

stoobly-agent intercept enable
  1. Replay your scenario.

Cleanup

After ovewriting your scenario successfully, you can disable intercepting requests with the Agent with the following command:

stoobly-agent intercept disable

You can also update your scenario key back to what it was before or you can clear it out so the Agent will not use any scenario. To clear the active scenario, run the following command:

stoobly-agent config scenario clear

Select the scenario you want to overwrite. To select the scenario, set the :

How to Update Scenarios
scenario key