Enterprise

OSS

Install Keploy

Keploy captures real API calls and database interactions, then helps you replay them as tests without rebuilding your full production environment.

Choose your setup path

info

Recommended: Keploy Enterprise CLI

Use this if you want the fastest setup, browser-based sign-in, and access to Keploy's Enterprise capabilities.

Keploy Enterprise CLI

Know More

This is the preferred way to install and use Keploy.

With this setup:

you install the recommended Keploy binary
you start using Keploy immediately
if authentication is required, Keploy opens a browser and signs you in automatically
once the flow is complete, Keploy is ready to use for record and test

How authentication works

When you run a command like:

keploy record
keploy test

and you are not already signed in, Keploy will:

open a browser window
ask you to sign in
return you to the CLI automatically

Install the recommended Keploy CLI

Follow the step below to install the Keploy Enterprise Agent:

curl --silent -O -L https://keploy.io/ent/install.sh && source install.sh

Record Your First Test

Once Keploy is installed, run your application through Keploy. This captures your real API calls and database interactions.

keploy record -c "YOUR_START_COMMAND"

Example: keploy record -c "npm start" or keploy record -c "go run main.go"

If you are not authenticated yet, the recommended CLI will automatically open the browser login flow and continue after sign-in.

Replay and Verify

After recording is complete, stop your app and run:

keploy test -c "YOUR_START_COMMAND" --delay 10

Keploy will replay the captured traffic so you can run your tests without depending on the original database or external services.

Automatic Cloud / Sandbox Behavior

Cloud backup and sandbox sync will be documented here very soon, once the rollout is live.

Why is this the recommended path?

Know More

Use the recommended Keploy Enterprise CLI if you want:

the easiest install experience
built-in browser-based authentication
less manual setup
access to Enterprise Keploy capabilities
a smoother path for integrations and team workflows

Which path should I choose?

info

The Open Source version is best for HTTP / REST protocol.

If you need support for gRPC, Redis, GraphQL, webhooks, and advanced integration workflows, use the Enterprise version.

For broader framework and protocol support, we recommend installing Keploy Enterprise.

Feature Comparison

Feature	Open Source	Enterprise
Dependencies
HTTP	Yes	Yes
MySQL	Yes	Yes
gRPC Outgoing	No	Yes
Mongo	No	Yes
Postgres	No	Yes
Redis	No	Yes
SQS	No	Yes
Kafka	No	Yes
HTTP2	No	Yes
Incoming Tests
HTTP	Yes	Yes
gRPC Incoming	Yes	Yes
Extra Features
Mock Upload	No	Yes
Time Freezing	No	Yes
Deduplication (Static + Codepath)	No	Yes
Sandboxing for Existing E2E / Integration Tests	No	Yes

Setup: Open-source

Choose your OS to get started 🚀

Linux
macOS
Windows

info

Make sure your Linux kernel version is 5.10 or higher.

👉 Choose your preferred method:

Native
Docker

1. Install Keploy

curl --silent -O -L https://keploy.io/install.sh && source install.sh

2. Once done, You should see something like this:

   ▓██▓▄
▓▓▓▓██▓█▓▄
 ████████▓▒
      ▀▓▓███▄      ▄▄   ▄               ▌
     ▄▌▌▓▓████▄    ██ ▓█▀  ▄▌▀▄  ▓▓▌▄   ▓█  ▄▌▓▓▌▄ ▌▌   ▓
   ▓█████████▌▓▓   ██▓█▄  ▓█▄▓▓ ▐█▌  ██ ▓█  █▌  ██  █▌ █▓
  ▓▓▓▓▀▀▀▀▓▓▓▓▓▓▌  ██  █▓  ▓▌▄▄ ▐█▓▄▓█▀ █▓█ ▀█▄▄█▀   █▓█
   ▓▌                           ▐█▌                   █▌
    ▓

Keploy CLI

Available Commands:
  example           Example to record and test via keploy
  config --generate generate the keploy configuration file
  record            record the keploy testcases from the API calls
  test              run the recorded testcases and execute assertions
  update            Update Keploy

Flags:
      --debug     Run in debug mode
  -h, --help      help for keploy
  -v, --version   version for keploy

Use "keploy [command] --help" for more information about a command.

🎉 Congratulations!

You’ve successfully installed Keploy on Linux.

🎬 Start Capturing Test Cases

Go
Node.js
Java
Python

Record the test cases

keploy record -c "go run main.go"

Run the test cases

keploy test -c "go run main.go" --delay 10

Record the test cases

keploy record -c "npm start"

Run the test cases

keploy test -c "npm start" --delay 10

Record the test cases

keploy record -c "mvn spring-boot:run"

Run the test cases

keploy test -c "mvn spring-boot:run" --delay 10

Record the test cases

keploy record -c "python app.py"

Run the test cases

keploy test -c "python app.py" --delay 10

📖 What’s Next?

Now, take it further by following the Quickstart Guide and see Keploy in action with your app.

Install Keploy with Docker on Linux

Make sure Docker is installed: You’ll need Docker installed on Linux
Install Keploy

   curl --silent -O -L https://keploy.io/install.sh && source install.sh

Once done, You should see something like this:

    ▓██▓▄
 ▓▓▓▓██▓█▓▄
  ████████▓▒
       ▀▓▓███▄      ▄▄   ▄               ▌
      ▄▌▌▓▓████▄    ██ ▓█▀  ▄▌▀▄  ▓▓▌▄   ▓█  ▄▌▓▓▌▄ ▌▌   ▓
    ▓█████████▌▓▓   ██▓█▄  ▓█▄▓▓ ▐█▌  ██ ▓█  █▌  ██  █▌ █▓
   ▓▓▓▓▀▀▀▀▓▓▓▓▓▓▌  ██  █▓  ▓▌▄▄ ▐█▓▄▓█▀ █▓█ ▀█▄▄█▀   █▓█
    ▓▌                           ▐█▌                   █▌
     ▓

 Keploy CLI

 Available Commands:
   example           Example to record and test via keploy
   config --generate generate the keploy configuration file
   record            record the keploy testcases from the API calls
   test              run the recorded testcases and execute assertions
   update            Update Keploy

 Flags:
       --debug     Run in debug mode
   -h, --help      help for keploy
   -v, --version   version for keploy

 Use "keploy [command] --help" for more information about a command.

🎉 Congratulations!

You’ve successfully set up Keploy on Linux using Docker.

🎬 Start Capturing Test Cases

Docker
Docker Compose

Record the test cases

keploy record -c "docker run -p <appPort>:<hostPort> --name <containerName> --network keploy-network --rm <applicationImage>" --containerName "<containerName>" --delay 10

Run the test cases

keploy test -c "docker run -p <appPort>:<hostPort> --name <containerName> --network keploy-network --rm <applicationImage>" --containerName "<containerName>" --delay 20

Record the test cases

keploy record -c "docker compose up" --container-name <containerName> --build-delay 100

Run the test cases

keploy test -c "docker compose up" --container-name <containerName> --build-delay 50 --delay 20

📖 What’s Next?

Now, take it further by following the Quickstart Guide and see Keploy in action with your app.

info

Keploy does not natively support macOS. However, you can run it using Lima or Docker.

👉 Choose your preferred method:

Lima
Docker

Install Keploy with Lima

Check if Lima is installed: If you already have Lima, Go to Step 6.
Install Lima

brew install lima

Create a Debian instance [or any instance of your choice]

limactl create template://debian-12

Start the instance

limactl start debian-12

Enter the Linux shell

limactl shell debian-12

Install Keploy inside Lima

curl --silent -O -L https://keploy.io/install.sh && source install.sh

Once done, You should see something like this:

       ▓██▓▄
    ▓▓▓▓██▓█▓▄
     ████████▓▒
          ▀▓▓███▄      ▄▄   ▄               ▌
         ▄▌▌▓▓████▄    ██ ▓█▀  ▄▌▀▄  ▓▓▌▄   ▓█  ▄▌▓▓▌▄ ▌▌   ▓
       ▓█████████▌▓▓   ██▓█▄  ▓█▄▓▓ ▐█▌  ██ ▓█  █▌  ██  █▌ █▓
      ▓▓▓▓▀▀▀▀▓▓▓▓▓▓▌  ██  █▓  ▓▌▄▄ ▐█▓▄▓█▀ █▓█ ▀█▄▄█▀   █▓█
       ▓▌                           ▐█▌                   █▌
        ▓

Keploy CLI

Available Commands:
  example           Example to record and test via keploy
  config --generate generate the keploy configuration file
  record            record the keploy testcases from the API calls
  test              run the recorded testcases and execute assertions
  update            Update Keploy

Flags:
      --debug     Run in debug mode
  -h, --help      help for keploy
  -v, --version   version for keploy

Use "keploy [command] --help" for more information about a command.

🎉 Congratulations!

You’ve successfully set up Keploy on macOS using Lima.

🎬 Start Capturing Test Cases

Go
Node.js
Java
Python

Record the test cases

keploy record -c "go run main.go"

Run the test cases

keploy test -c "go run main.go" --delay 10

Record the test cases

keploy record -c "npm start"

Run the test cases

keploy test -c "npm start" --delay 10

Record the test cases

keploy record -c "mvn spring-boot:run"

Run the test cases

keploy test -c "mvn spring-boot:run" --delay 10

Record the test cases

keploy record -c "python app.py"

Run the test cases

keploy test -c "python app.py" --delay 10

📖 What’s Next?

Now, take it further by following the Quickstart Guide and see Keploy in action with your app.

Install Keploy with Docker on macOS

Make sure Docker is installed: You’ll need Docker Desktop running on macOS.
Install Keploy

curl --silent -O -L https://keploy.io/install.sh && source install.sh

Verify the installation

Once done, You should see something like this:

       ▓██▓▄
    ▓▓▓▓██▓█▓▄
     ████████▓▒
          ▀▓▓███▄      ▄▄   ▄               ▌
         ▄▌▌▓▓████▄    ██ ▓█▀  ▄▌▀▄  ▓▓▌▄   ▓█  ▄▌▓▓▌▄ ▌▌   ▓
       ▓█████████▌▓▓   ██▓█▄  ▓█▄▓▓ ▐█▌  ██ ▓█  █▌  ██  █▌ █▓
      ▓▓▓▓▀▀▀▀▓▓▓▓▓▓▌  ██  █▓  ▓▌▄▄ ▐█▓▄▓█▀ █▓█ ▀█▄▄█▀   █▓█
       ▓▌                           ▐█▌                   █▌
        ▓

Keploy CLI

Available Commands:
  example           Example to record and test via keploy
  config --generate generate the keploy configuration file
  record            record the keploy testcases from the API calls
  test              run the recorded testcases and execute assertions
  update            Update Keploy

Flags:
      --debug     Run in debug mode
  -h, --help      help for keploy
  -v, --version   version for keploy

Use "keploy [command] --help" for more information about a command.

🎉 Congratulations!

You’ve successfully set up Keploy on macOS using Docker.

🎬 Start Capturing Test Cases

Docker
Docker Compose

Record the test cases

keploy record -c "docker run -p <appPort>:<hostPort> --name <containerName> --network keploy-network --rm <applicationImage>" --containerName "<containerName>" --delay 10

Run the test cases

keploy test -c "docker run -p <appPort>:<hostPort> --name <containerName> --network keploy-network --rm <applicationImage>" --containerName "<containerName>" --delay 20

Record the test cases

keploy record -c "docker compose up" --container-name <containerName> --build-delay 100

Run the test cases

keploy test -c "docker compose up" --container-name <containerName> --build-delay 50 --delay 20

📖 What’s Next?

Now, take it further by following the Quickstart Guide and see Keploy in action with your app.

info

You can run Keploy Natively or using WSL or Docker. If you want to run Keploy natively, make sure to do it as an administrator.

👉 Choose your preferred method:

Native
WSL
Docker

Note: Native Windows support is available only for AMD. For ARM-based systems, please use WSL or Docker.

1. Create a Directory

Use this command to create a directory for Keploy:


New-Item -ItemType Directory -Force -Path "$env:APPDATA\Keploy\bin"

2. Install Keploy

Run this command to install the Keploy exe:

Invoke-WebRequest -Uri "https://github.com/keploy/keploy/releases/latest/download/keploy_windows_amd64.exe" -OutFile "$env:APPDATA\Keploy\bin\keploy.exe"

3. Set Environment Variable

Add the directory containing the Keploy binary to your system user’s PATH environment variable to make the keploy command available globally.

C:\Users\"Your Username"\AppData\Roaming\Keploy\bin

4. Finalize Setup

Checks: Close all the terminals.
Run as Admin: Open your terminal as Administrator.
Troubleshooting: If you face issues, ensure cmd.exe and powershell.exe (default paths in Windows) are in your system environment variables.

5. Verify Installation

Once done, You should see something like this:

   ▓██▓▄
▓▓▓▓██▓█▓▄
 ████████▓▒
      ▀▓▓███▄      ▄▄   ▄               ▌
     ▄▌▌▓▓████▄    ██ ▓█▀  ▄▌▀▄  ▓▓▌▄   ▓█  ▄▌▓▓▌▄ ▌▌   ▓
   ▓█████████▌▓▓   ██▓█▄  ▓█▄▓▓ ▐█▌  ██ ▓█  █▌  ██  █▌ █▓
  ▓▓▓▓▀▀▀▀▓▓▓▓▓▓▌  ██  █▓  ▓▌▄▄ ▐█▓▄▓█▀ █▓█ ▀█▄▄█▀   █▓█
   ▓▌                           ▐█▌                   █▌
    ▓

Keploy CLI

Available Commands:
  example           Example to record and test via keploy
  config --generate generate the keploy configuration file
  record            record the keploy testcases from the API calls
  test              run the recorded testcases and execute assertions
  update            Update Keploy

Flags:
      --debug     Run in debug mode
  -h, --help      help for keploy
  -v, --version   version for keploy

Use "keploy [command] --help" for more information about a command.

🎉 Congratulations!

You’ve successfully installed Keploy on Windows.

🎬 Start Capturing Test Cases

Go
Node.js
Java
Python

Record the test cases

keploy record -c "go run main.go"

Run the test cases

keploy test -c "go run main.go" --delay 10

Record the test cases

keploy record -c "npm start"

Run the test cases

keploy test -c "npm start" --delay 10

Record the test cases

keploy record -c "mvn spring-boot:run"

Run the test cases

keploy test -c "mvn spring-boot:run" --delay 10

Record the test cases

keploy record -c "python app.py"

Run the test cases

keploy test -c "python app.py" --delay 10

📖 What’s Next?

Now, take it further by following the Quickstart Guide and see Keploy in action with your app.

Install Keploy with WSL

If you already have WSL, Go to Step 2.

Note: Make sure you’re on:

Windows 10 (version 2004 or later, build 19041+)
Windows 11

Run the following command in PowerShell (as Administrator):

Enable WSL

wsl --install -d <Distribution Name>

👉 We recommend using Ubuntu-22.04 for the best experience. (You can also choose a different distribution if needed.)

Install Keploy Binary Inside your WSL terminal, run:

curl --silent -O -L https://keploy.io/install.sh && source install.sh

Verify Installation

       ▓██▓▄
    ▓▓▓▓██▓█▓▄
     ████████▓▒
          ▀▓▓███▄      ▄▄   ▄               ▌
         ▄▌▌▓▓████▄    ██ ▓█▀  ▄▌▀▄  ▓▓▌▄   ▓█  ▄▌▓▓▌▄ ▌▌   ▓
       ▓█████████▌▓▓   ██▓█▄  ▓█▄▓▓ ▐█▌  ██ ▓█  █▌  ██  █▌ █▓
      ▓▓▓▓▀▀▀▀▓▓▓▓▓▓▌  ██  █▓  ▓▌▄▄ ▐█▓▄▓█▀ █▓█ ▀█▄▄█▀   █▓█
       ▓▌                           ▐█▌                   █▌
        ▓

Keploy CLI

Available Commands:
  example           Example to record and test via keploy
  config --generate generate the keploy configuration file
  record            record the keploy testcases from the API calls
  test              run the recorded testcases and execute assertions
  update            Update Keploy

Flags:
      --debug     Run in debug mode
  -h, --help      help for keploy
  -v, --version   version for keploy

Use "keploy [command] --help" for more information about a command.

🎉 Congratulations!

You’ve successfully set up Keploy on Windows using WSL.

🎬 Start Capturing Test Cases

Go
Node.js
Java
Python

Record the test cases

keploy record -c "go run main.go"

Run the test cases

keploy test -c "go run main.go" --delay 10

Record the test cases

keploy record -c "npm start"

Run the test cases

keploy test -c "npm start" --delay 10

Record the test cases

keploy record -c "mvn spring-boot:run"

Run the test cases

keploy test -c "mvn spring-boot:run" --delay 10

Record the test cases

keploy record -c "python app.py"

Run the test cases

keploy test -c "python app.py" --delay 10

📖 What’s Next?

Now, take it further by following the Quickstart Guide and see Keploy in action with your app.

Install Keploy with Docker on Windows

Make sure Docker is installed : You’ll need Docker Desktop running on Windows.
Install Keploy

curl --silent -O -L https://keploy.io/install.sh && source install.sh

Verify the installation

Once done, You should see something like this:

       ▓██▓▄
    ▓▓▓▓██▓█▓▄
     ████████▓▒
          ▀▓▓███▄      ▄▄   ▄               ▌
         ▄▌▌▓▓████▄    ██ ▓█▀  ▄▌▀▄  ▓▓▌▄   ▓█  ▄▌▓▓▌▄ ▌▌   ▓
       ▓█████████▌▓▓   ██▓█▄  ▓█▄▓▓ ▐█▌  ██ ▓█  █▌  ██  █▌ █▓
      ▓▓▓▓▀▀▀▀▓▓▓▓▓▓▌  ██  █▓  ▓▌▄▄ ▐█▓▄▓█▀ █▓█ ▀█▄▄█▀   █▓█
       ▓▌                           ▐█▌                   █▌
        ▓

Keploy CLI

Available Commands:
  example           Example to record and test via keploy
  config --generate generate the keploy configuration file
  record            record the keploy testcases from the API calls
  test              run the recorded testcases and execute assertions
  update            Update Keploy

Flags:
      --debug     Run in debug mode
  -h, --help      help for keploy
  -v, --version   version for keploy

Use "keploy [command] --help" for more information about a command.

🎉 Congratulations!

You’ve successfully set up Keploy on Windows using Docker.

🎬 Start Capturing Test Cases

Docker
Docker Compose

Record the test cases

keploy record -c "docker run -p <appPort>:<hostPort> --name <containerName> --network keploy-network --rm <applicationImage>" --containerName "<containerName>" --delay 10

Run the test cases

keploy test -c "docker run -p <appPort>:<hostPort> --name <containerName> --network keploy-network --rm <applicationImage>" --containerName "<containerName>" --delay 20

Record the test cases

keploy record -c "docker compose up" --container-name <containerName> --build-delay 100

Run the test cases

keploy test -c "docker compose up" --container-name <containerName> --build-delay 50 --delay 20

📖 What’s Next?

Now, take it further by following the Quickstart Guide and see Keploy in action with your app.

Choose your setup path​

Recommended: Keploy Enterprise CLI​

Keploy Enterprise CLI​

How authentication works​

Install the recommended Keploy CLI​

Record Your First Test​

Replay and Verify​

Automatic Cloud / Sandbox Behavior​

Why is this the recommended path?​

Which path should I choose?​

Feature Comparison​

Setup: Open-source​

1. Install Keploy​

2. Once done, You should see something like this:​

🎉 Congratulations!​

🎬 Start Capturing Test Cases

📖 What’s Next?

Install Keploy with Docker on Linux​

🎉 Congratulations!​

🎬 Start Capturing Test Cases

📖 What’s Next?

Install Keploy with Lima​

🎉 Congratulations!​

🎬 Start Capturing Test Cases

📖 What’s Next?

Install Keploy with Docker on macOS​

🎉 Congratulations!​

🎬 Start Capturing Test Cases

📖 What’s Next?

1. Create a Directory​

2. Install Keploy​

3. Set Environment Variable​

4. Finalize Setup​

5. Verify Installation​

🎉 Congratulations!​

🎬 Start Capturing Test Cases

📖 What’s Next?

Install Keploy with WSL​

🎉 Congratulations!​

🎬 Start Capturing Test Cases

📖 What’s Next?

Install Keploy with Docker on Windows​

🎉 Congratulations!​

🎬 Start Capturing Test Cases

📖 What’s Next?

Choose your setup path

Recommended: Keploy Enterprise CLI

Keploy Enterprise CLI

How authentication works

Install the recommended Keploy CLI

Record Your First Test

Replay and Verify

Automatic Cloud / Sandbox Behavior

Why is this the recommended path?

Which path should I choose?

Feature Comparison

Setup: Open-source

1. Install Keploy

2. Once done, You should see something like this:

🎉 Congratulations!

Install Keploy with Docker on Linux

🎉 Congratulations!

Install Keploy with Lima

🎉 Congratulations!

Install Keploy with Docker on macOS

🎉 Congratulations!

1. Create a Directory

2. Install Keploy

3. Set Environment Variable

4. Finalize Setup

5. Verify Installation

🎉 Congratulations!

Install Keploy with WSL

🎉 Congratulations!

Install Keploy with Docker on Windows

🎉 Congratulations!