Skip to main content
View as Markdown

Installing Keploy on Windows​

Keploy runs natively on Windows — you can record and replay an app that runs directly on Windows, with no WSL and no Docker. There is no eBPF on Windows, so Keploy instruments the application it starts and intercepts its network calls in user space. No driver loads, nothing is installed system-wide, and you do not need Administrator.

Native Windows support covers apps in Go, Node.js, Python and Java. WSL and Docker remain available if you prefer them.

👉 Choose your preferred method:

Option 1: Run Keploy natively​

  1. Install Keploy — download the Windows build from the releases page (or your Keploy distribution) and put keploy.exe on your PATH.

  2. Open a terminal. An ordinary PowerShell or Terminal window is enough — Keploy does not need to run elevated.

  3. Record your app — pass the command that starts it:

    keploy record -c "<your app command>"

    For example:

    keploy record -c ".\myapp.exe"        # Go
    keploy record -c "node server.js"     # Node.js
    keploy record -c "python app.py"      # Python

  4. Replay the recorded tests:

    keploy test -c "<your app command>" --delay 10
note

Native Windows support is x86‑64 only, and the application under test must be 64-bit. On Windows/ARM, use WSL or Docker.

note

Keploy instruments the application it starts, so launch your app through keploy record -c or keploy test -c rather than starting it yourself and pointing Keploy at a running process.

Keploy intercepts TCP — HTTP, HTTPS, gRPC, and database and cache protocols — and resolves hostnames through the application's resolver, so a dependency that no longer exists is still answered from its Mock during a replay. Traffic an application sends over UDP is not recorded.

Option 2: Install Keploy with WSL​

If you already have WSL, Go to Step 2.

  1. Enable WSL

    Make sure you’re on:

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

    Run the following command in PowerShell (as Administrator):

    wsl --install -d <Distribution Name>

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

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

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

  2. 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 3: Install Keploy with Docker​

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

  2. Create a Docker bridge network

    docker network create keploy-network

  3. Install Keploy

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

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