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
- macOS
- Windows
Installing Keploy on Linux is super easy it works on any Linux distribution with a simple one-command installation
1. Install Keploy
curl --silent -O -L https://keploy.io/install.sh && source install.sh
2. Verify Installation
keploy --version
✅ If you see the version number, Keploy has been installed successfully!
🎉 Congratulations!
You’ve successfully installed Keploy on Linux.
Keploy does not natively support macOS. However, you can run it using Lima or Docker.
👉 Choose your preferred method:
Option 1: 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 -
Verify the installation
keploy --version
✅ If the version shows up, Keploy is installed successfully!
What's Next?
🎬 Start Capturing Test Cases
Begin recording your API calls and automatically generate test cases with Keploy.
Option 2: Install Keploy with Docker on macOS
-
Make sure Docker is installed: You’ll need Docker Desktop running on macOS.
-
Create a Docker bridge network
docker network create keploy-network -
Install Keploy
curl --silent -O -L https://keploy.io/install.sh && source install.sh -
Verify the installation
keploy --version
✅ If the version shows up, Keploy is installed successfully!
What's Next?
🎬 Start Capturing Test cases
▶️ Record
keploy record -c "docker run -p 8080:8080 --name <containerName> --network keploy-network <applicationImage>" \
--container-name "<containerName>" --buildDelay 60
🧪 Test
keploy test -c "docker run -p 8080:8080 --name <containerName> --network keploy-network <applicationImage>" \
--delay 10 --buildDelay 60
🎉 Congratulations!
You’ve successfully set up Keploy on macOS using either Lima or Docker.
Keploy does not natively support Windows. However, you can run it using WSL or Docker.
👉 Choose your preferred method:
Option 1: 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 --version✅ If you see the version number, Keploy is installed successfully!
What's Next?
🎬 Start Capturing Test Cases
Begin recording your API calls and automatically generate test cases with Keploy.
Option 2: Install Keploy with Docker on WSL
-
Make sure Docker is installed : You’ll need Docker Desktop running on Windows.
-
Create a Docker bridge network
docker network create keploy-network -
Install Keploy
curl --silent -O -L https://keploy.io/install.sh && source install.sh -
Verify the installation
keploy --version
✅ If the version shows up, Keploy is installed successfully!
What's Next?
🎬 Start Capturing Test cases
▶️ Record
keploy record -c "docker run -p 8080:8080 --name <containerName> --network keploy-network <applicationImage>" \
--container-name "<containerName>" --buildDelay 60
🧪 Test
keploy test -c "docker run -p 8080:8080 --name <containerName> --network keploy-network <applicationImage>" \
--delay 10 --buildDelay 60
🎉 Congratulations!
You’ve successfully set up Keploy on Windows using either WSL or Docker.