Skip to main content

Running Keploy Natively on Windows​

View as Markdown

Keploy relies on the Linux kernel's eBPF subsystem to capture network traffic, so it does not run directly on the Windows kernel. On Windows you run Keploy inside WSL (Windows Subsystem for Linux), which gives you a real Linux kernel while keeping your Windows development environment. This page covers the WSL prerequisites and installs the Keploy binary inside that Linux environment.

Prerequisites​

  • Windows 10 version 2004 or higher (Build 19041 and higher), or Windows 11.
  • Administrator access to run wsl --install the first time.
  • A working internet connection to pull the WSL distribution and the Keploy release.

Enable WSL and install a Linux distribution​

Open PowerShell or Windows Terminal as Administrator and run:

wsl --install -d <Distribution Name>

We recommend "Ubuntu-22.04":

wsl --install -d Ubuntu-22.04

This command enables the features necessary to run WSL and installs the chosen Ubuntu distribution of Linux. (The default distribution can be changed.) You may be prompted to restart Windows and to create a Linux username and password on first launch.

Install the Keploy binary​

Once you are inside your WSL Ubuntu shell, install the Keploy binary:

curl --silent --location "https://github.com/keploy/keploy/releases/latest/download/keploy_linux_amd64.tar.gz" | tar xz -C /tmp

sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin && keploy

Running keploy should print the CLI help, confirming the binary is on your PATH. From here on, run every Keploy command from inside the WSL shell (not native PowerShell), and keep your application code on the WSL filesystem for the best performance.

Congratulations! You've successfully set up Keploy natively on Windows.

What's Next?​

🎬 Start Capturing Testcases​

Begin recording your API calls and generating test cases with Keploy.

Back to Installation Guide​