Installing Keploy

Keploy uses eBPF to intercept API calls at the network layer and generate test cases and mocks/stubs.
Choose your OS to get started 🚀

Linux

info

Make sure your Linux kernel version is 5.10 or higher.

👉 Choose your preferred method:

Native

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

Record the test cases

keploy record -c "go run main.go"

Run the test cases

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

Node.js

Record the test cases

keploy record -c "npm start"

Run the test cases

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

Java

Record the test cases

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

Run the test cases

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

Python

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.

Docker

Install Keploy with Docker on Linux

1. Make sure Docker is installed: You’ll need Docker installed on Linux

2. Install Keploy

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

3. 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

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

Docker Compose

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.

macOS

info

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

👉 Choose your preferred method:

Lima

Install Keploy with Lima

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

2. Install Lima

brew install lima

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

   limactl create template://debian-12

4. Start the instance

   limactl start debian-12

5. Enter the Linux shell

   limactl shell debian-12

6. Install Keploy inside Lima

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

7. 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

Record the test cases

keploy record -c "go run main.go"

Run the test cases

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

Node.js

Record the test cases

keploy record -c "npm start"

Run the test cases

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

Java

Record the test cases

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

Run the test cases

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

Python

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.

Docker

Install Keploy with Docker on macOS

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

2. Install Keploy

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

3. 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

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

Docker Compose

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.

Windows

info

Keploy does not natively support Windows. However, you can run it using WSL or Docker.

👉 Choose your preferred method:

WSL

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):

1. 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.)

2. Install Keploy Binary Inside your WSL terminal, run:

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

3. 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

Record the test cases

keploy record -c "go run main.go"

Run the test cases

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

Node.js

Record the test cases

keploy record -c "npm start"

Run the test cases

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

Java

Record the test cases

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

Run the test cases

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

Python

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.

Docker

Install Keploy with Docker on Windows

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

2. Install Keploy

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

3. 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

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

Docker Compose

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.