Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
1f9d01c
docs: add a Universal Mocker reference from the Keploy 3.9.4 CLI
slayerjain Nov 20, 2026
b91dda4
docs: add env vars, exit codes and replay results to the mock reference
slayerjain Nov 20, 2026
c46cad0
docs: add a Universal Mocker troubleshooting page from Keploy 3.9.4
slayerjain Nov 20, 2026
cdf4613
docs: add a Universal Mocker network isolation guide from Keploy 3.9.4
slayerjain Nov 20, 2026
bfdbee4
docs: add a Universal Mocker guide to times and ids that change
slayerjain Nov 20, 2026
3e5b104
docs: add a Universal Mocker guide to partial re-record
slayerjain Nov 20, 2026
293d4bb
docs: add a Universal Mocker features page
slayerjain Nov 20, 2026
bc0382c
docs: add a VS Code walkthrough to the Universal Mocker section
slayerjain Nov 20, 2026
235408a
docs: add a Keploy Cloud dashboard walkthrough for the Universal Mocker
slayerjain Nov 20, 2026
280526e
docs: add a Universal Mocker coding-agent guide and llms.txt entries
slayerjain Nov 20, 2026
9fdfa7d
docs: add a Universal Mocker guide with notes for each dependency
slayerjain Nov 20, 2026
cc474b5
docs: add a Universal Mocker guide to start-up and background calls
slayerjain Nov 20, 2026
1772889
docs: add a Universal Mocker guide to branches and pull requests
slayerjain Nov 20, 2026
1858c40
docs: add a Universal Mocker guide to running the replay in CI
slayerjain Nov 20, 2026
06bc52a
docs: add real VS Code screenshots and the pinned-app merge path
slayerjain Nov 20, 2026
291c94f
docs: show the real VS Code record, replay and red-test screens
slayerjain Nov 20, 2026
c263635
docs: add a Universal Mocker quickstart for the VS Code extension
slayerjain Nov 20, 2026
aebc328
docs: link the Universal Mocker reference and VS Code quickstart
slayerjain Nov 20, 2026
2e79ffa
docs: say what a Universal Mocker replay does with an unrecorded call
slayerjain Nov 20, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions content/llms-full-root.txt
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ There is one product to install: `keploy`. Recording and replaying tests need a

## Products

Keploy offers three core products:
Keploy offers four core products:

### 1. Integration Testing (Record and Replay)
Record-replay engine that captures API calls at the network layer and generates test suites with deterministic replay. It captures HTTP/HTTPS, gRPC, WebSocket, and GraphQL traffic and automatically creates replayable test cases with mocked dependencies (databases, external APIs, message queues). Tests are stored as YAML files in the project directory.
Expand All @@ -45,6 +45,10 @@ AI-powered unit test generation from PR diffs and source code. The Test Agent an
### 3. API Test Generation
Generate API tests from OpenAPI specs, Postman collections, cURL commands, or real user traffic. Supports functional tests, edge case tests, performance tests, security tests, and dependency tests. AI models route tasks to the best-suited model and validate results to ensure high-quality output.

### 4. Universal Mocker (Service Virtualization)
Service virtualization for the tests a team already has. `keploy mock record -c "<test command>"` runs the team's own test command (go test, pytest, Jest, mvn test, Playwright, or a script) once against the real databases, queues and HTTP or gRPC services and saves each outgoing call with its answer. `keploy mock replay -c "<test command>"` then runs the same command with those dependencies switched off and answers each call from the recording; by default a call that matches no recording gets an error instead of a real answer, and the replay names it. No mock code is written and no test changes, and the test framework still decides which tests pass. With `KEPLOY_PROVEN=1` each test is also replayed on its own before its recording is kept, and, when signed in with an app named in keploy.yml, the recordings go to Keploy Cloud under a Keploy branch named after the git branch (never main); the repository holds only keploy.yml and keploy.lock, which pins each test to its recordings, and CI replays what keploy.lock pins. Runs on Linux, macOS (Apple silicon, no admin rights) and Docker; the Keploy VS Code extension installs the CLI and sets a project up through the user's coding agent.
- URL: https://keploy.io/docs/universal-mocker/overview/

---

## Technical Architecture
Expand Down Expand Up @@ -475,7 +479,7 @@ For current, publicly substantiated security, privacy, and compliance informatio
## Integrations

### IDE Integrations
- VS Code Extension (Keploy: API & DB Mocks): records the API and database calls your tests make and replays them offline with `keploy mock`, from a panel in VS Code. It also sets up AI coding agents and adds a CI job that replays the recording. It does not generate unit tests. See the Marketplace for current installs.
- VS Code Extension (Keploy: API Testing, Mocks & Service Virtualization): installs the Keploy CLI, signs you in, and hands the `keploy mock` setup of your tests to your coding agent (Claude Code, GitHub Copilot or Cursor), which records the API and database calls your tests make so they replay offline. It also writes a GitHub Actions workflow that replays the recording on every pull request. It does not generate unit tests. See the Marketplace for current installs.
- URL: https://keploy.io/docs/running-keploy/utg-vscode-extension/

### PR Agent Integration
Expand Down
27 changes: 26 additions & 1 deletion content/llms-root.txt
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,31 @@ Keploy (founded 2021) is a CNCF Landscape project and API testing platform with
- [Flaky Test Elimination](https://keploy.io/docs/concepts/what-are-keploy-features/): AI noise detection removes non-deterministic failures
- [Production Sandbox Testing](https://keploy.io/docs/concepts/what-is-keploy/): Production-like environments without staging infrastructure

## Universal Mocker (Service Virtualization)
- [Universal Mocker overview](https://keploy.io/docs/universal-mocker/overview/): Service virtualization for the tests you already have: `keploy mock record` runs your own test command (go test, pytest, Jest, mvn test, Playwright) against the real databases, queues and APIs once, then `keploy mock replay` runs it with them switched off; which product to use, platforms and supported dependencies
- [Go quickstart](https://keploy.io/docs/universal-mocker/quickstarts/go/): Run go test without PostgreSQL or an HTTP API, then check each test on its own
- [Python quickstart](https://keploy.io/docs/universal-mocker/mock-quickstart/): Run pytest without the API it calls, with no Keploy account
- [Node.js quickstart](https://keploy.io/docs/universal-mocker/quickstarts/jest/): Run Jest without the API it calls, with no Keploy account
- [Java quickstart](https://keploy.io/docs/universal-mocker/quickstarts/java/): Run JUnit tests with mvn test without the API they call
- [Playwright quickstart](https://keploy.io/docs/universal-mocker/quickstarts/playwright/): Run a Playwright suite without the API your web app calls
- [Docker Compose quickstart](https://keploy.io/docs/universal-mocker/quickstarts/docker-compose/): Run tests without the PostgreSQL and Redis services of a compose file
- [VS Code quickstart](https://keploy.io/docs/universal-mocker/quickstarts/vscode/): Record and replay a Go test suite's PostgreSQL and HTTP calls from the Keploy VS Code extension
- [VS Code walkthrough](https://keploy.io/docs/universal-mocker/walkthroughs/vscode/): Install the extension, let it download the CLI, sign in, hand the setup to your coding agent, record, replay, read a red test and wire CI
- [Keploy Cloud dashboard walkthrough](https://keploy.io/docs/universal-mocker/walkthroughs/dashboard/): A Keploy branch's recordings, the review of a pull request's changes, and its merge into main
- [Mock your tests](https://keploy.io/docs/universal-mocker/mock-your-tests/): The full guide to keploy mock record and replay: the on-miss policy, per-test checks with KEPLOY_PROVEN=1, per-test scoping for any framework, and platforms
- [keploy.yml and keploy.lock](https://keploy.io/docs/universal-mocker/guides/keploy-yml-and-lock/): Which files to commit, how keploy.lock pins each test to its recordings, and how the lock follows Keploy branches
- [Branches and pull requests](https://keploy.io/docs/universal-mocker/guides/branches-and-prs/): How recordings follow git branches through keploy.lock, what a pull request shows, how main is listed after a merge, and how to resolve a keploy.lock conflict
- [Partial re-record](https://keploy.io/docs/universal-mocker/guides/partial-re-record/): Record a new test or re-record one test without running the whole suite against the real dependencies
- [Run the replay in CI](https://keploy.io/docs/universal-mocker/guides/ci/): The GitHub Actions workflow that replays every pull request with no dependency running, the read-only CI key, caching, what fails the job, and other CI systems
- [Network isolation](https://keploy.io/docs/universal-mocker/guides/network-isolation/): What a replay keeps off the real network, and how to let a call out on purpose
- [Times, dates and ids that change](https://keploy.io/docs/universal-mocker/guides/changing-values/): How a replay handles the time, dates, random ids and expiring tokens your tests send
- [Start-up calls and background work](https://keploy.io/docs/universal-mocker/guides/background-workers/): Where Keploy records the calls your app makes outside a test, which test a replay answers each one in, and how sessionCalls serves a call to every test
- [Notes for each dependency](https://keploy.io/docs/universal-mocker/guides/dependencies/): How Keploy tells dependencies apart and reads TLS, and what a replay does with PostgreSQL and MySQL logins, Redis blocking pops and Amazon SQS polls
- [Coding agents](https://keploy.io/docs/universal-mocker/guides/coding-agents/): Install the mocking skill for Claude Code, Cursor, Codex, GitHub Copilot or Antigravity with keploy skill install mock, and let the agent record and replay by following the NEXT block each keploy mock command prints
- [Features](https://keploy.io/docs/universal-mocker/features/): Every Universal Mocker capability, each with a link to its guide
- [Troubleshooting](https://keploy.io/docs/universal-mocker/troubleshooting/): What record and replay print when something goes wrong, its cause and the fix, including calls with no recording and replays that fail only in CI
- [Reference](https://keploy.io/docs/universal-mocker/reference/): Every keploy mock command and flag, the keploy.yml keys, environment variables, exit codes and replay results

## UI Testing (Beta)
- [UI Testing overview](https://keploy.io/docs/running-keploy/ui-capture/): Record real user sessions in a web app with the capture SDK (@keploy/capture-sdk) and read each visit as UI flows and journeys in the dashboard, over the REST API, or from an AI agent through MCP
- [Dashboard quickstart](https://keploy.io/docs/ui-capture/quickstart-dashboard/): Create an ingest key, add it to a sample React shop, and see your first flows
Expand All @@ -76,7 +101,7 @@ Keploy (founded 2021) is a CNCF Landscape project and API testing platform with

## Keploy Cloud & Integrations
- [Enterprise plan](https://keploy.io/docs/keploy-cloud/cloud-installation/): Getting started on the Enterprise plan — install Keploy, sign in, and the plan's features
- [VS Code Extension](https://keploy.io/docs/keploy-explained/integrations-vscode/): IDE integration for test generation
- [VS Code Extension](https://keploy.io/docs/keploy-explained/integrations-vscode/): Sets up Keploy's dependency mocks for your tests through your coding agent, then records, replays and wires CI from VS Code
- [PR Agent Integration](https://keploy.io/docs/keploy-explained/integrations-pr-agent/): Automated test suggestions on pull requests


Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ keywords:

# IDE integrations — VS Code

Keploy's VS Code extension, **Keploy: API & DB Mocks**, sets up the [`keploy mock`](/docs/universal-mocker/mock-your-tests/) loop through the coding agent you already use. Keploy records the real calls your tests make to APIs and databases, then replays your tests with those dependencies switched off. The extension installs the Keploy CLI for you, signs you in, installs Keploy's skill for your project, and hands the setup to Claude Code, GitHub Copilot or Cursor's agent. It then shows what the CLI reports about each test, and stages the setup's files for you to commit.
Keploy's VS Code extension, **Keploy: API Testing, Mocks & Service Virtualization**, sets up the [`keploy mock`](/docs/universal-mocker/mock-your-tests/) loop through the coding agent you already use. Keploy records the real calls your tests make to APIs and databases, then replays your tests with those dependencies switched off. The extension installs the Keploy CLI for you, signs you in, installs Keploy's skill for your project, and hands the setup to Claude Code, GitHub Copilot or Cursor's agent. It then shows what the CLI reports about each test, and stages the setup's files for you to commit.

Install it from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=keploy.keployio), then follow the [VS Code extension guide](/docs/running-keploy/utg-vscode-extension/).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ keywords:
- keploy.keployio
---

The **Keploy VS Code extension** (listed as **Keploy: API & DB Mocks**, ID `keploy.keployio`) sets Keploy up for your tests through the coding agent you already use. Keploy records the real calls each of your tests makes to its dependencies, such as HTTP and gRPC APIs, databases, caches and queues, and replays them from the recording, so the same suite runs green with none of those dependencies contacted, on your laptop and in CI.
The **Keploy VS Code extension** (listed as **Keploy: API Testing, Mocks & Service Virtualization**, ID `keploy.keployio`) sets Keploy up for your tests through the coding agent you already use. Keploy records the real calls each of your tests makes to its dependencies, such as HTTP and gRPC APIs, databases, caches and queues, and replays them from the recording, so the same suite runs green with none of those dependencies contacted, on your laptop and in CI.

The extension doesn't write your tests or your integration. It installs the Keploy CLI, signs you in, installs Keploy's skill for your project, and hands the setup to your agent. Your agent then runs the CLI's [`keploy mock`](/docs/universal-mocker/mock-your-tests/) commands, and the extension shows what the CLI reports about each test.

Expand All @@ -45,7 +45,7 @@ Version 3.1.0 replaces the 3.0.0 panel. Setting Keploy up, recording and replayi

## Install the extension

1. In VS Code, open the **Extensions** view, search for **Keploy**, and select **Install** on **Keploy: API & DB Mocks**. You can also install it from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=keploy.keployio), or from a terminal:
1. In VS Code, open the **Extensions** view, search for **Keploy**, and select **Install** on **Keploy: API Testing, Mocks & Service Virtualization**. You can also install it from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=keploy.keployio), or from a terminal:

```bash
code --install-extension keploy.keployio
Expand Down Expand Up @@ -110,14 +110,14 @@ When the replay is green, select **keploy.yml, keploy.lock and the test edits st

Select **CI replays keploy.lock (GitHub Actions)** in the checklist, or run **Keploy: Wire CI (GitHub Actions)**. For a Go or Node project in a GitHub repository, the extension writes `.github/workflows/keploy.yml`, never over a file that is already there. On every pull request and every push to main, the workflow runs `keploy mock replay --lock keploy.lock --on-miss fail` with `KEPLOY_PROVEN=1`, and comments on the pull request what its `keploy.lock` changes.

The replay lets no download out, so before it the workflow sets up your project's toolchain and installs its dependencies, in the folder your test command runs in: the repository's root, or the folder its first `cd` goes to. The extension reads the toolchain from the program your test command runs (`go` for Go; `npm`, `npx`, `pnpm`, `yarn`, `node`, `jest` or `playwright` for Node) or, for a command such as `make test`, from that folder's files (a `go.mod`, or a `package.json` with its lockfile):
The replay lets no download out, so before it the workflow sets up your project's toolchain and installs its dependencies, in the folder your test command runs in: the project's folder, or the folder its first `cd` goes to. The extension reads the toolchain from the program your test command runs (`go` for Go; `npm`, `npx`, `pnpm`, `yarn`, `node`, `jest` or `playwright` for Node) or, for a command such as `make test`, from that folder's files (a `go.mod`, or a `package.json` with its lockfile):

- **Go:** `actions/setup-go` with your `go.mod`'s Go version, then `go mod download`.
- **Node:** `actions/setup-node`, then an install from your lockfile: `npm ci`, or pnpm's or Yarn's frozen install through corepack (`npm install` when there's no lockfile).

The workflow needs one repository secret, `KEPLOY_API_KEY`: a read-only CI key. Your Keploy admin makes it at [Account > Service Accounts](https://app.keploy.io/settings/service-accounts): a service account with the **MOCK_READER** role on your app, and a key for it. Store it with `gh secret set KEPLOY_API_KEY`. The notification the extension shows has a button that opens that page and one that copies the command.

For any other project, such as a Python or Java one, a test command that runs several toolchains, or one whose toolchain the extension can't tell, Wire CI writes no workflow: CI setup for it is available on request. The same goes for GitLab CI and any other CI. Contact the Keploy team at support@keploy.io and we'll set it up with you. The extension also writes the workflow only for a project at the repository's root, once `keploy.lock` exists and Keploy has read your test command; otherwise it says what to do instead.
For any other project, such as a Python or Java one, a test command that runs several toolchains, or one whose toolchain the extension can't tell, Wire CI writes no workflow: CI setup for it is available on request. The same goes for GitLab CI and any other CI. Contact the Keploy team at support@keploy.io and we'll set it up with you. The extension writes the workflow once `keploy.lock` exists and Keploy has read your test command; otherwise it says what to do instead. For a project in a folder below the repository's root, such as `tests/e2e`, the workflow's steps run in that folder, and a Go project's `go.mod` can be there or in a folder above it.

## Invite teammates

Expand Down
Loading
Loading