# Stoobly Docs ## Stoobly Docs - [Introduction](https://docs.stoobly.com/readme.md): Stoobly is an API mock framework with seamless CI setup that enables end-to-end (E2E) testing. - [Use Cases](https://docs.stoobly.com/use-cases.md) - [Generate Mock APIs](https://docs.stoobly.com/use-cases/generate-mock-apis.md) - [Empower Development](https://docs.stoobly.com/use-cases/generate-mock-apis/empower-development.md) - [Scale API Testing](https://docs.stoobly.com/use-cases/generate-mock-apis/scale-api-testing.md) - [Enable E2E Testing](https://docs.stoobly.com/use-cases/enable-e2e-testing.md) - [FAQ](https://docs.stoobly.com/faq.md) - [API Testing](https://docs.stoobly.com/faq/api-testing.md) - [CA Cert](https://docs.stoobly.com/faq/ca-cert.md) - [Config](https://docs.stoobly.com/faq/config.md) - [Installation](https://docs.stoobly.com/faq/installation.md) - [Intercept](https://docs.stoobly.com/faq/intercept.md) - [Request](https://docs.stoobly.com/faq/request.md) - [Run](https://docs.stoobly.com/faq/run.md) - [Scaffold](https://docs.stoobly.com/faq/scaffold.md) - [Customization](https://docs.stoobly.com/faq/scaffold/customization.md) - [Docker](https://docs.stoobly.com/faq/scaffold/customization/docker.md) - [Local](https://docs.stoobly.com/faq/scaffold/customization/local.md) - [E2E Testing](https://docs.stoobly.com/faq/scaffold/e2e-testing.md) - [Docker](https://docs.stoobly.com/faq/scaffold/e2e-testing/docker.md) - [JS Client](https://docs.stoobly.com/faq/scaffold/e2e-testing/js-client.md) - [Setup](https://docs.stoobly.com/faq/scaffold/e2e-testing/js-client/setup.md) - [Playwright](https://docs.stoobly.com/faq/scaffold/e2e-testing/js-client/playwright.md) - [Cypress](https://docs.stoobly.com/faq/scaffold/e2e-testing/js-client/cypress.md) - [Configuration](https://docs.stoobly.com/faq/scaffold/e2e-testing/js-client/configuration.md) - [Troubleshooting & Examples](https://docs.stoobly.com/faq/scaffold/e2e-testing/js-client/troubleshooting.md) - [Local](https://docs.stoobly.com/faq/scaffold/e2e-testing/local.md) - [Runtime](https://docs.stoobly.com/faq/scaffold/runtime.md) - [Docker](https://docs.stoobly.com/faq/scaffold/runtime/docker.md) - [Local](https://docs.stoobly.com/faq/scaffold/runtime/local.md) - [Scenario](https://docs.stoobly.com/faq/scenario.md) - [Snapshot](https://docs.stoobly.com/faq/snapshot.md) - [Installing the Agent](https://docs.stoobly.com/getting-started/install-and-run.md): How to install Stoobly agent either with pip, Docker, or from source - [Installation with pipx](https://docs.stoobly.com/getting-started/install-and-run/installation-with-pipx.md): How to use pip to install Stoobly - [Installation with Docker](https://docs.stoobly.com/getting-started/install-and-run/installation-with-docker.md): How to use Docker to intall Stoobly - [Configuring an AI Assistant](https://docs.stoobly.com/getting-started/configuring-an-ai-assistant.md) - [LLM Rules](https://docs.stoobly.com/getting-started/configuring-an-ai-assistant/llm-rules.md) - [Skills](https://docs.stoobly.com/getting-started/configuring-an-ai-assistant/skills.md) - [Scaffold Create](https://docs.stoobly.com/getting-started/configuring-an-ai-assistant/skills/stoobly-scaffold-create.md) - [Triage](https://docs.stoobly.com/getting-started/configuring-an-ai-assistant/skills/stoobly-triage.md) - [Troubleshoot E2E Test](https://docs.stoobly.com/getting-started/configuring-an-ai-assistant/skills/stoobly-troubleshoot-e2e-test.md) - [Update Request](https://docs.stoobly.com/getting-started/configuring-an-ai-assistant/skills/stoobly-update-request.md) - [Agent](https://docs.stoobly.com/core-concepts/agent.md): Overview of Stoobly agent (stoobly-agent) - [Intercept Modes](https://docs.stoobly.com/core-concepts/agent/intercept-modes.md) - [Mocking](https://docs.stoobly.com/core-concepts/agent/intercept-modes/mocking.md) - [Recording](https://docs.stoobly.com/core-concepts/agent/intercept-modes/recording.md) - [Lifecycle Hooks](https://docs.stoobly.com/core-concepts/agent/lifecycle-hooks.md) - [Proxy Settings](https://docs.stoobly.com/core-concepts/agent/proxy-settings.md): Enables additional configuration on how to handle requests - [Data Rules](https://docs.stoobly.com/core-concepts/agent/proxy-settings/data-rules.md) - [Filter Rules](https://docs.stoobly.com/core-concepts/agent/proxy-settings/filter-rules.md) - [Rewrite Rules](https://docs.stoobly.com/core-concepts/agent/proxy-settings/rewrite-rules.md): How to rewrite portions of requests - [Match Rules](https://docs.stoobly.com/core-concepts/agent/proxy-settings/match-rules.md): How to define extra rules to match requests - [Context](https://docs.stoobly.com/core-concepts/context.md) - [Mock API](https://docs.stoobly.com/core-concepts/mock-api.md) - [Request](https://docs.stoobly.com/core-concepts/mock-api/requests.md): A Stoobly request represents a HTTP request - [Response](https://docs.stoobly.com/core-concepts/mock-api/requests/response.md): A Stoobly response represents a HTTP request's response - [Replay History](https://docs.stoobly.com/core-concepts/mock-api/requests/replay-history.md) - [Scenarios](https://docs.stoobly.com/core-concepts/mock-api/scenarios.md): A Stoobly cenario is a sequence of requests that describes a workflow - [Snapshots](https://docs.stoobly.com/core-concepts/mock-api/snapshots.md): A Stoobly snapshot is a collection of requests and scenarios - [Fixtures](https://docs.stoobly.com/core-concepts/mock-api/fixtures.md) - [Public Folder](https://docs.stoobly.com/core-concepts/mock-api/public-folder.md) - [Scaffold](https://docs.stoobly.com/core-concepts/scaffold.md) - [Service](https://docs.stoobly.com/core-concepts/scaffold/service.md) - [Validation](https://docs.stoobly.com/core-concepts/scaffold/validation.md) - [Workflow](https://docs.stoobly.com/core-concepts/scaffold/workflow.md) - [How to Run the Agent](https://docs.stoobly.com/guides/how-to-run-the-agent.md) - [Run with CLI](https://docs.stoobly.com/guides/how-to-run-the-agent/run-with-cli.md) - [Run with Docker](https://docs.stoobly.com/guides/how-to-run-the-agent/run-with-docker.md): How to use run Stoobly with Docker - [How to Configure the Agent](https://docs.stoobly.com/guides/proxy-configuration.md): How to configure Stoobly to intercept HTTP(s) traffic - [Forward Proxy](https://docs.stoobly.com/guides/proxy-configuration/forward-proxy.md): Configure the proxy to intercept outbound requests - [Enable HTTPS Traffic](https://docs.stoobly.com/guides/proxy-configuration/forward-proxy/enable-https-traffic.md): Configure the forward proxy to intercept HTTPS traffic - [Reverse Proxy](https://docs.stoobly.com/guides/proxy-configuration/reverse-proxy.md): Configure the proxy to intercept inbound requests - [How to Record Requests](https://docs.stoobly.com/guides/how-to-record-requests.md): Overview of recording HTTP(s) requests - [Recording from the UI](https://docs.stoobly.com/guides/how-to-record-requests/recording-from-the-ui.md) - [Recording from the CLI](https://docs.stoobly.com/guides/how-to-record-requests/recording-from-the-cli.md) - [How to Create Contexts](https://docs.stoobly.com/guides/how-to-record-requests/how-to-create-contexts.md) - [How to Create Scenarios](https://docs.stoobly.com/guides/how-to-record-requests/how-to-create-scenarios.md): Overview of creating scenarios - [Creating from the UI](https://docs.stoobly.com/guides/how-to-record-requests/how-to-create-scenarios/creating-from-the-ui.md) - [Creating from the CLI](https://docs.stoobly.com/guides/how-to-record-requests/how-to-create-scenarios/creating-from-the-cli.md) - [How to Create Requests](https://docs.stoobly.com/guides/how-to-record-requests/how-to-create-requests.md) - [How to Customize Recordings](https://docs.stoobly.com/guides/how-to-record-requests/how-to-customize-recordings.md) - [Customizing with Lifecycle Hooks](https://docs.stoobly.com/guides/how-to-record-requests/how-to-customize-recordings/customizing-with-lifecycle-hooks.md) - [How to Update Requests](https://docs.stoobly.com/guides/how-to-update-requests.md) - [Editing from the UI](https://docs.stoobly.com/guides/how-to-update-requests/editing-from-the-ui.md) - [Editing with Snapshots](https://docs.stoobly.com/guides/how-to-update-requests/editing-with-snapshots.md) - [How to Update Scenarios](https://docs.stoobly.com/guides/how-to-update-requests/how-to-update-scenarios.md) - [Updating with Overwrite](https://docs.stoobly.com/guides/how-to-update-requests/how-to-update-scenarios/updating-with-overwrite.md) - [Updating with Replay](https://docs.stoobly.com/guides/how-to-update-requests/how-to-update-scenarios/updating-with-replay.md) - [Updating with Replay](https://docs.stoobly.com/guides/how-to-update-requests/updating-with-replay.md) - [Replaying from the UI](https://docs.stoobly.com/guides/how-to-update-requests/updating-with-replay/replaying-from-the-ui.md) - [Replaying from the CLI](https://docs.stoobly.com/guides/how-to-update-requests/updating-with-replay/replaying-from-the-cli.md) - [How to Customize Replays](https://docs.stoobly.com/guides/how-to-update-requests/updating-with-replay/how-to-customize-replays.md) - [Customizing with Lifecycle Hooks](https://docs.stoobly.com/guides/how-to-update-requests/updating-with-replay/how-to-customize-replays/customizing-with-lifecycle-hooks.md) - [Updating with OpenAPI](https://docs.stoobly.com/guides/how-to-update-requests/updating-with-openapi.md) - [How to Mock APIs](https://docs.stoobly.com/guides/how-to-mock-apis.md) - [How to Enable Mocking](https://docs.stoobly.com/guides/how-to-mock-apis/how-to-enable-mocking.md) - [Enabling from the UI](https://docs.stoobly.com/guides/how-to-mock-apis/how-to-enable-mocking/enabling-from-the-ui.md) - [Enabling from the CLI](https://docs.stoobly.com/guides/how-to-mock-apis/how-to-enable-mocking/enabling-from-the-cli.md) - [How to Snapshot Requests](https://docs.stoobly.com/guides/how-to-mock-apis/how-to-snapshot-requests.md) - [Deleting Snapshots](https://docs.stoobly.com/guides/how-to-mock-apis/how-to-snapshot-requests/deleting-snapshots.md) - [Sharing Snapshots](https://docs.stoobly.com/guides/how-to-mock-apis/how-to-snapshot-requests/sharing-snapshots.md) - [How to Use Fixtures](https://docs.stoobly.com/guides/how-to-mock-apis/how-to-use-fixtures.md) - [How to Customize Mocking](https://docs.stoobly.com/guides/how-to-mock-apis/how-to-customize-mocking.md) - [Customizing with Lifecycle Hooks](https://docs.stoobly.com/guides/how-to-mock-apis/how-to-customize-mocking/customizing-with-lifecycle-hooks.md) - [Customizing with Request Headers](https://docs.stoobly.com/guides/how-to-mock-apis/how-to-customize-mocking/customizing-with-request-headers.md) - [Troubleshooting](https://docs.stoobly.com/guides/how-to-mock-apis/troubleshooting.md) - [How to Replay Requests](https://docs.stoobly.com/guides/how-to-replay-requests.md): Replay HTTP(s) requests - [Replay with the UI](https://docs.stoobly.com/guides/how-to-replay-requests/replay-with-the-ui.md) - [Replay with the CLI](https://docs.stoobly.com/guides/how-to-replay-requests/replay-with-the-cli.md) - [How to Integrate E2E Testing](https://docs.stoobly.com/guides/how-to-integrate-e2e-testing.md) - [How to Scaffold an App](https://docs.stoobly.com/guides/how-to-integrate-e2e-testing/how-to-scaffold-an-app.md) - [Scaffolding a Service](https://docs.stoobly.com/guides/how-to-integrate-e2e-testing/how-to-scaffold-an-app/scaffolding-a-service.md) - [Customizing a Workflow](https://docs.stoobly.com/guides/how-to-integrate-e2e-testing/how-to-scaffold-an-app/customizing-a-workflow.md) - [Customizing Container Services](https://docs.stoobly.com/guides/how-to-integrate-e2e-testing/how-to-scaffold-an-app/customizing-a-workflow/customizing-container-services.md) - [Customizing Lifecycle Hooks](https://docs.stoobly.com/guides/how-to-integrate-e2e-testing/how-to-scaffold-an-app/customizing-a-workflow/customizing-lifecycle-hooks.md) - [Customizing Init Scripts](https://docs.stoobly.com/guides/how-to-integrate-e2e-testing/how-to-scaffold-an-app/customizing-a-workflow/customizing-init-scripts.md) - [Customizing Makefile](https://docs.stoobly.com/guides/how-to-integrate-e2e-testing/how-to-scaffold-an-app/customizing-a-workflow/customizing-makefile.md) - [Troubleshooting](https://docs.stoobly.com/guides/how-to-integrate-e2e-testing/how-to-scaffold-an-app/troubleshooting.md) - [How to Run a Workflow](https://docs.stoobly.com/guides/how-to-integrate-e2e-testing/how-to-run-a-workflow.md) - [Running with CLI command](https://docs.stoobly.com/guides/how-to-integrate-e2e-testing/how-to-run-a-workflow/running-with-cli-command.md) - [Running with Make](https://docs.stoobly.com/guides/how-to-integrate-e2e-testing/how-to-run-a-workflow/running-with-make.md) - [Troubleshooting](https://docs.stoobly.com/guides/how-to-integrate-e2e-testing/how-to-run-a-workflow/troubleshooting.md) - [Validating](https://docs.stoobly.com/guides/how-to-integrate-e2e-testing/how-to-run-a-workflow/troubleshooting/validating.md) - [How to Stop a Workflow](https://docs.stoobly.com/guides/how-to-integrate-e2e-testing/how-to-stop-a-workflow.md) - [Stopping with CLI command](https://docs.stoobly.com/guides/how-to-integrate-e2e-testing/how-to-stop-a-workflow/stopping-with-cli-command.md) - [Stopping with Make](https://docs.stoobly.com/guides/how-to-integrate-e2e-testing/how-to-stop-a-workflow/stopping-with-make.md) - [How to Show What Workflow Is Running](https://docs.stoobly.com/guides/how-to-integrate-e2e-testing/how-to-show-what-workflow-is-running.md) - [Showing with CLI command](https://docs.stoobly.com/guides/how-to-integrate-e2e-testing/how-to-show-what-workflow-is-running/showing-with-cli-command.md) - [How to Update a Scaffold](https://docs.stoobly.com/guides/how-to-integrate-e2e-testing/how-to-update-a-scaffold.md) - [Deleting a Service](https://docs.stoobly.com/guides/how-to-integrate-e2e-testing/how-to-update-a-scaffold/deleting-a-service.md) - [FAQ](https://docs.stoobly.com/guides/how-to-integrate-e2e-testing/faq.md) - [Libraries](https://docs.stoobly.com/libraries/libraries.md) - [JavaScript](https://docs.stoobly.com/libraries/libraries/javascript.md) - [Installation from Source](https://docs.stoobly.com/developer-guide/installation-from-source.md) - [Submitting Change Requests](https://docs.stoobly.com/developer-guide/submitting-change-requests.md) - [Releases](https://docs.stoobly.com/developer-guide/releases.md) - [Experimental Features](https://docs.stoobly.com/experimental/experimental-features.md): New features potentially in the pipeline - [Aliases](https://docs.stoobly.com/experimental/experimental-features/aliases.md): As your project grows, certain endpoints may have path components that can be substituted for different values. We call these "wildcard" path components aliases. - [Endpoints](https://docs.stoobly.com/experimental/experimental-features/endpoints.md): An endpoint is a group of requests with a similar path. - [API Testing](https://docs.stoobly.com/experimental/experimental-features/api-testing.md) - [Getting Started](https://docs.stoobly.com/experimental/experimental-features/api-testing/getting-started.md) - [Configuration](https://docs.stoobly.com/experimental/experimental-features/api-testing/configuration.md) - [Assign](https://docs.stoobly.com/experimental/experimental-features/api-testing/configuration/assign.md) - [Lifecycle Hooks](https://docs.stoobly.com/experimental/experimental-features/api-testing/configuration/lifecycle-hooks.md) - [Trace](https://docs.stoobly.com/experimental/experimental-features/api-testing/configuration/trace.md) - [Optional Components](https://docs.stoobly.com/experimental/experimental-features/optional-components.md)