From 7903f6db97e60ad9b2a260b1f9cbf0ff7098893c Mon Sep 17 00:00:00 2001 From: slayerjain Date: Tue, 22 Sep 2026 14:25:13 +0530 Subject: [PATCH 1/6] docs(macos): say the native CLI is Apple Silicon only, and route Intel Macs to Lima macOS 27 ends support for Intel Macs, and Keploy now ships macOS as arm64 only: the installer, `keploy update`, the Homebrew formula and the VS Code extension all refuse an Intel Mac and link here. Docker is called out as NOT an Intel route on every page that offers it. Your app and the agent run in containers, but the keploy CLI that starts them is the native build on the host, so Lima -- which installs the Linux build inside the VM -- is the one that works. Two notes in concepts/installation.md said Keploy is "not supported on MacOS natively", which stopped being true when native macOS support shipped; they now say what is actually the case. version-1.0.0 is left alone: it pins v0.9.1, a release that really does publish keploy_darwin_all.tar.gz. Signed-off-by: slayerjain --- content/llms-full-root.txt | 4 ++-- .../version-4.0.0/concepts/installation.md | 4 ++-- .../concepts/platform-requirements.md | 12 ++++++------ versioned_docs/version-4.0.0/installation/macos.md | 14 +++++++++++++- .../version-4.0.0/keploy-explained/dev-guide.md | 6 +++++- .../version-4.0.0/keploy-explained/mac-linux.md | 2 +- .../running-keploy/mock-quickstart.md | 5 +++-- .../version-4.0.0/server/installation_tabs.md | 6 +++++- .../version-4.0.0/server/macos/installation.md | 10 ++++++++-- 9 files changed, 45 insertions(+), 18 deletions(-) diff --git a/content/llms-full-root.txt b/content/llms-full-root.txt index 8b7fbd453f..499461f985 100644 --- a/content/llms-full-root.txt +++ b/content/llms-full-root.txt @@ -98,7 +98,7 @@ keploy version ``` ### macOS -Requires Docker Desktop or Colima. Install via the same script or Homebrew. +Runs natively on Apple Silicon (arm64) only — install via the same script or `brew install keploy/tap/keploy`; no Docker needed (userspace interception, no root). Both refuse to install on an Intel Mac: there, run Keploy inside a Lima VM (https://keploy.io/docs/installation/macos-installation/#option-2-install-keploy-with-lima). The Docker Desktop/Colima route still runs the native CLI on the host, so it is also Apple Silicon only. ### Windows Requires WSL2 (Windows Subsystem for Linux). Install within the WSL2 environment using the Linux installation method. @@ -108,7 +108,7 @@ Keploy can run as a Docker container alongside your application using Docker Com ### Platform Requirements - Linux: Kernel version 5.15+ recommended for eBPF support -- macOS: Docker Desktop or Colima required (eBPF runs inside the Linux VM) +- macOS: Apple Silicon (arm64) for the native CLI; Intel Macs run Keploy in a Lima VM (Linux build inside the VM) - Windows: WSL2 with a compatible Linux kernel --- diff --git a/versioned_docs/version-4.0.0/concepts/installation.md b/versioned_docs/version-4.0.0/concepts/installation.md index e65fc4257a..7abe781e10 100644 --- a/versioned_docs/version-4.0.0/concepts/installation.md +++ b/versioned_docs/version-4.0.0/concepts/installation.md @@ -85,7 +85,7 @@ Use "keploy [command] --help" for more information about a command. #### On macOS/Windows -Note : Keploy is not supported natively on MacOS and Windows, so you can follow the below method to run with docker +Note : With this method your application and Keploy's agent run in Docker, but the `keploy` CLI installed below — which starts them both — runs on your machine. On macOS that CLI is the native build, which is Apple Silicon (arm64) only — on an Intel Mac, run Keploy with [Lima](/docs/installation/macos-installation/#option-2-install-keploy-with-lima) instead. 1. Open up a terminal window. @@ -151,7 +151,7 @@ sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin/keploy ``` -> Note: Keploy is not supported on MacOS natively. +> Note: On macOS, Keploy's native CLI is Apple Silicon (arm64) only — see [Installing Keploy on macOS](/docs/installation/macos-installation/). On an Intel Mac, run Keploy with [Lima](/docs/installation/macos-installation/#option-2-install-keploy-with-lima), which installs the Linux build above inside the VM. **_Setting up the Docker Desktop for WSL 2_** diff --git a/versioned_docs/version-4.0.0/concepts/platform-requirements.md b/versioned_docs/version-4.0.0/concepts/platform-requirements.md index 5810242f60..f862effb9d 100644 --- a/versioned_docs/version-4.0.0/concepts/platform-requirements.md +++ b/versioned_docs/version-4.0.0/concepts/platform-requirements.md @@ -26,10 +26,10 @@ keywords: Below is a table summarizing the tools needed for both native and Docker installations of Keploy on macOS, Windows, and Linux: -| Operating System | Without Docker | Docker Installation | Prerequisites | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| macOS **macOS** | Supported Native (Go, Node, Python, Java) | [Guide](/server/install/) | - Docker Desktop version must be 4.25.2 or above
- Ensure that Lima is installed on your machine if you prefer to try without Docker. | -| Windows **Windows** | Supported Native, x86‑64 (Go, Node, Python, Java) | [Guide](/server/install/) | - Use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install#install-wsl-command) `wsl --install`
- Windows 10 version 2004 and higher (Build 19041 and higher) or Windows 11
- Ensure that Docker Desktop version 4.25.2 or above is installed if you are following the Docker installation guide | -| Linux **Linux** | Supported | Supported | Linux kernel 5.15 or higher | +| Operating System | Without Docker | Docker Installation | Prerequisites | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| macOS **macOS** | Supported Native, Apple Silicon (Go, Node, Python, Java) | [Guide](/server/install/) | - Docker Desktop version must be 4.25.2 or above
- Ensure that Lima is installed on your machine if you prefer to try without Docker. | +| Windows **Windows** | Supported Native, x86‑64 (Go, Node, Python, Java) | [Guide](/server/install/) | - Use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install#install-wsl-command) `wsl --install`
- Windows 10 version 2004 and higher (Build 19041 and higher) or Windows 11
- Ensure that Docker Desktop version 4.25.2 or above is installed if you are following the Docker installation guide | +| Linux **Linux** | Supported | Supported | Linux kernel 5.15 or higher | -Keploy runs natively on macOS and Windows (x86‑64) — neither has eBPF, so it intercepts traffic in userspace on both, and neither needs `sudo` or Administrator. Docker, Lima (macOS) and WSL (Windows) remain supported alternatives, and are still the route on Windows/ARM. +Keploy runs natively on macOS (Apple Silicon / arm64) and Windows (x86‑64) — neither has eBPF, so it intercepts traffic in userspace on both, and neither needs `sudo` or Administrator. Docker, Lima (macOS) and WSL (Windows) remain supported alternatives, and are still the route on Windows/ARM. On an Intel Mac use Lima: the Docker route on macOS still runs the native CLI on the host, so it is Apple Silicon only too. diff --git a/versioned_docs/version-4.0.0/installation/macos.md b/versioned_docs/version-4.0.0/installation/macos.md index 668e1b4d47..5ab83689d9 100644 --- a/versioned_docs/version-4.0.0/installation/macos.md +++ b/versioned_docs/version-4.0.0/installation/macos.md @@ -15,7 +15,7 @@ keywords: # Installing Keploy on macOS -Keploy now runs **natively on macOS** — you can record and replay an app that runs directly on your Mac, with no Lima VM and no Docker. Native macOS support intercepts traffic in userspace (there is no eBPF on macOS), so it needs no root and installs nothing system-wide. +Keploy now runs **natively on macOS** (Apple Silicon) — you can record and replay an app that runs directly on your Mac, with no Lima VM and no Docker. Native macOS support intercepts traffic in userspace (there is no eBPF on macOS), so it needs no root and installs nothing system-wide. Native macOS support covers **Go, Node.js, Python and Java** apps, including their HTTPS traffic. Docker and Lima remain available if you prefer to run your app in a container. @@ -41,6 +41,12 @@ A free account is enough to record and replay. Free-tier runs are subject to a u ## Option 1: Run Keploy natively +:::note Apple Silicon only + +The native macOS build is **Apple Silicon (arm64) only**. On an Intel Mac the installer, the Homebrew formula and `keploy update` refuse to install rather than fetch a binary that cannot run there. If one of them sent you here, use [Option 2 (Lima)](#option-2-install-keploy-with-lima), which installs the Linux build inside the VM. [Option 3 (Docker)](#option-3-install-keploy-with-docker) is not an Intel route either: it starts your app and Keploy's agent in containers, but the `keploy` CLI that drives it is the same native build running on your Mac. + +::: + 1. **Install Keploy** ```bash @@ -128,6 +134,12 @@ Begin recording your API calls and automatically generate test cases with Keploy ## Option 3: Install Keploy with Docker +:::note Also Apple Silicon only + +With this option your application and Keploy's agent run in containers, but the `keploy` CLI installed in step 3 — which starts them both — is the native macOS build, which is Apple Silicon (arm64) only. On an Intel Mac use [Option 2 (Lima)](#option-2-install-keploy-with-lima) instead. + +::: + 1. **Make sure Docker is installed** You’ll need Docker Desktop running on macOS. diff --git a/versioned_docs/version-4.0.0/keploy-explained/dev-guide.md b/versioned_docs/version-4.0.0/keploy-explained/dev-guide.md index 6ada5145dd..dd2288a502 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/dev-guide.md +++ b/versioned_docs/version-4.0.0/keploy-explained/dev-guide.md @@ -199,7 +199,7 @@ curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss
:::info -Keploy runs natively on macOS (Go, Node, Python and Java apps). You can also run it using **Lima** or **Docker**. +Keploy runs natively on Apple Silicon Macs (Go, Node, Python and Java apps). You can also run it using **Lima** or **Docker**. The native CLI is Apple Silicon (arm64) only and the Docker method still runs it on your Mac, so on an Intel Mac use **Lima**. ::: @@ -247,6 +247,10 @@ curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss ### Install Keploy OSS with Docker on macOS +:::note Apple Silicon only +Your application and Keploy's agent run in containers here, but the `keploy` CLI installed in step 2 — which starts them both — is the native macOS build, which is Apple Silicon (arm64) only. On an Intel Mac use the **Lima** tab instead. +::: + 1. Make sure Docker Desktop is running on macOS. 2. Install Keploy diff --git a/versioned_docs/version-4.0.0/keploy-explained/mac-linux.md b/versioned_docs/version-4.0.0/keploy-explained/mac-linux.md index 4c9436dfd8..60006a0268 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/mac-linux.md +++ b/versioned_docs/version-4.0.0/keploy-explained/mac-linux.md @@ -46,7 +46,7 @@ description: "Run Keploy natively on macOS by setting up a Debian Linux VM with cd /Users/{Username} ``` -8. Run the following command to install Keploy +8. Run the following command to install Keploy. The Lima VM has the same architecture as your Mac, so this downloads `keploy_linux_arm64.tar.gz` for Apple Silicon; on an Intel Mac use `keploy_linux_amd64.tar.gz` instead. ```bash curl --silent --location "https://github.com/keploy/keploy/releases/latest/download/keploy_linux_arm64.tar.gz" | tar xz --overwrite -C /tmp diff --git a/versioned_docs/version-4.0.0/running-keploy/mock-quickstart.md b/versioned_docs/version-4.0.0/running-keploy/mock-quickstart.md index a06ef1a3c5..44eda4a422 100644 --- a/versioned_docs/version-4.0.0/running-keploy/mock-quickstart.md +++ b/versioned_docs/version-4.0.0/running-keploy/mock-quickstart.md @@ -30,8 +30,9 @@ command shows the **real output** you should see — nothing is faked. keploy --version ``` -- **Linux** (root, for eBPF) or **Windows amd64** (Administrator). On **macOS**, - run your tests through a docker command (shown at the end). +- **Linux** (root, for eBPF) or **Windows amd64** (Administrator). On + **macOS (Apple Silicon)**, run your tests through a docker command (shown at + the end). - Python 3. (`go test` / `npm test` work identically — only the test command changes.) diff --git a/versioned_docs/version-4.0.0/server/installation_tabs.md b/versioned_docs/version-4.0.0/server/installation_tabs.md index 0a9cf84f29..3cadf93265 100644 --- a/versioned_docs/version-4.0.0/server/installation_tabs.md +++ b/versioned_docs/version-4.0.0/server/installation_tabs.md @@ -230,7 +230,7 @@ Use "keploy [command] --help" for more information about a command.
:::info -Keploy runs natively on macOS (Go, Node, Python and Java apps). You can also run it using **Lima** or **Docker**. +Keploy runs natively on Apple Silicon Macs (Go, Node, Python and Java apps). You can also run it using **Lima** or **Docker**. The native CLI is Apple Silicon (arm64) only and the Docker method still runs it on your Mac, so on an Intel Mac use **Lima**. ::: 👉 **Choose your preferred method:** @@ -359,6 +359,10 @@ Use "keploy [command] --help" for more information about a command. ## Install Keploy with Docker on macOS +:::note Apple Silicon only +Your application and Keploy's agent run in containers here, but the `keploy` CLI installed in step 2 — which starts them both — is the native macOS build, which is Apple Silicon (arm64) only. On an Intel Mac use the **Lima** tab instead. +::: + 1. **Make sure Docker is installed**: You’ll need Docker Desktop running on macOS. 2. **Install Keploy** diff --git a/versioned_docs/version-4.0.0/server/macos/installation.md b/versioned_docs/version-4.0.0/server/macos/installation.md index 89f4a5d44c..795cdc0f6a 100644 --- a/versioned_docs/version-4.0.0/server/macos/installation.md +++ b/versioned_docs/version-4.0.0/server/macos/installation.md @@ -2,7 +2,7 @@ id: installation title: macOS Installation sidebar_label: macOS -description: "Install Keploy on macOS with the one-click curl installer or Homebrew. Docker Desktop and Colima setups are also supported for eBPF testing." +description: "Install Keploy on macOS (Apple Silicon) with the one-click curl installer or Homebrew. Docker Desktop and Colima setups are also supported for eBPF testing." tags: - hello-world - macos @@ -32,7 +32,7 @@ description="Install the Keploy CLI on macOS using the one-click curl installer totalTime="PT5M" estimatedCost={{currency: "USD", value: "0"}} tools={["bash", "curl", "Homebrew (optional)"]} -supplies={["A macOS machine"]} +supplies={["An Apple Silicon Mac"]} visible={false} steps={[ { @@ -55,6 +55,12 @@ There are two ways to install Keploy on macOS: For users who need eBPF support, a [manual setup with Docker Desktop or Colima](#manual-setup) is also available. +:::note Apple Silicon only + +Both routes install the native Keploy CLI, which is built for **Apple Silicon (arm64) only** — the installer stops with a message on an Intel Mac, and the Homebrew formula refuses to install there. The [manual Docker Desktop / Colima setup](#manual-setup) below is driven by that same CLI: it starts your app and Keploy's eBPF agent in containers inside the Linux VM, but the CLI itself runs on your Mac, so that route is Apple Silicon only too. On an Intel Mac, run Keploy with [Lima](/docs/installation/macos-installation/#option-2-install-keploy-with-lima) instead. + +::: + ## One-click install Keploy Run the following command in your terminal: From b0c706fa8d58e848a227fa7f86bbe2b50d350a83 Mon Sep 17 00:00:00 2001 From: slayerjain Date: Tue, 22 Sep 2026 14:28:29 +0530 Subject: [PATCH 2/6] =?UTF-8?q?docs:=20stop=20saying=20Keploy=20cannot=20r?= =?UTF-8?q?un=20natively=20on=20macOS=20=E2=80=94=20the=20Community=20buil?= =?UTF-8?q?d=20can?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit "Keploy is not supported natively on MacOS" was a statement about the OSS build (eBPF, Linux only) written as if it were the product. The userspace macOS and Windows backends ship in the Community/Enterprise build, which is what keploy.io/install.sh installs by DEFAULT — `--oss` is what selects the eBPF one. Every page now names which build it is describing. - keploy-explained/dev-guide.md installs with `--oss` throughout, so its macOS tab claiming native support was wrong in the other direction. It now says the OSS build has no macOS backend, points at the Community build for native recording, and its Windows tab does the same instead of implying WSL/Docker are all that exist. - running-keploy/mock-your-tests.md and mock-quickstart.md listed macOS as container-only, and told Windows users to open an Administrator shell. Native record on macOS and 64-bit Windows is supported (cmd/enterprise/cli/provider/core_others.go), and userspace interception needs neither Administrator nor sudo. - concepts/platform-requirements.md now names the builds instead of leaving "Keploy runs natively" to mean whichever one the reader has. Signed-off-by: slayerjain --- .../version-4.0.0/concepts/platform-requirements.md | 2 +- .../version-4.0.0/keploy-explained/dev-guide.md | 12 ++++++++---- .../version-4.0.0/running-keploy/mock-quickstart.md | 8 +++++--- .../version-4.0.0/running-keploy/mock-your-tests.md | 11 ++++++++--- 4 files changed, 22 insertions(+), 11 deletions(-) diff --git a/versioned_docs/version-4.0.0/concepts/platform-requirements.md b/versioned_docs/version-4.0.0/concepts/platform-requirements.md index f862effb9d..8f04135902 100644 --- a/versioned_docs/version-4.0.0/concepts/platform-requirements.md +++ b/versioned_docs/version-4.0.0/concepts/platform-requirements.md @@ -32,4 +32,4 @@ Linux: | Windows **Windows** | Supported Native, x86‑64 (Go, Node, Python, Java) | [Guide](/server/install/) | - Use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install#install-wsl-command) `wsl --install`
- Windows 10 version 2004 and higher (Build 19041 and higher) or Windows 11
- Ensure that Docker Desktop version 4.25.2 or above is installed if you are following the Docker installation guide | | Linux **Linux** | Supported | Supported | Linux kernel 5.15 or higher | -Keploy runs natively on macOS (Apple Silicon / arm64) and Windows (x86‑64) — neither has eBPF, so it intercepts traffic in userspace on both, and neither needs `sudo` or Administrator. Docker, Lima (macOS) and WSL (Windows) remain supported alternatives, and are still the route on Windows/ARM. On an Intel Mac use Lima: the Docker route on macOS still runs the native CLI on the host, so it is Apple Silicon only too. +Keploy runs natively on macOS (Apple Silicon / arm64) and Windows (x86‑64) in the Community and Enterprise builds — which is what `https://keploy.io/install.sh` installs by default. Neither platform has eBPF, so Keploy intercepts traffic in userspace on both, and neither needs `sudo` or Administrator. (The OSS build, `install.sh --oss`, intercepts with eBPF and records a natively-running app on Linux only; on macOS and Windows it works through Docker.) Docker, Lima (macOS) and WSL (Windows) remain supported alternatives, and are still the route on Windows/ARM. On an Intel Mac use Lima: the Docker route on macOS still runs the native CLI on the host, so it is Apple Silicon only too. diff --git a/versioned_docs/version-4.0.0/keploy-explained/dev-guide.md b/versioned_docs/version-4.0.0/keploy-explained/dev-guide.md index dd2288a502..6e8c6c52f3 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/dev-guide.md +++ b/versioned_docs/version-4.0.0/keploy-explained/dev-guide.md @@ -199,7 +199,9 @@ curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss
:::info -Keploy runs natively on Apple Silicon Macs (Go, Node, Python and Java apps). You can also run it using **Lima** or **Docker**. The native CLI is Apple Silicon (arm64) only and the Docker method still runs it on your Mac, so on an Intel Mac use **Lima**. +This page installs **Keploy OSS** (`install.sh --oss`), which intercepts traffic with eBPF — Linux only. It has no native macOS backend, so on a Mac you run it through **Lima** or **Docker**. + +Native macOS recording — your app running directly on your Mac, no VM and no containers — ships in the **Community** build, which is what the installer gives you when you drop `--oss`. See [Installing Keploy on macOS](/docs/installation/macos-installation/). That build is Apple Silicon (arm64) only. ::: @@ -247,8 +249,8 @@ curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss ### Install Keploy OSS with Docker on macOS -:::note Apple Silicon only -Your application and Keploy's agent run in containers here, but the `keploy` CLI installed in step 2 — which starts them both — is the native macOS build, which is Apple Silicon (arm64) only. On an Intel Mac use the **Lima** tab instead. +:::note +Your application and Keploy's agent both run in containers here, which is what makes this work on a Mac at all: the OSS build cannot intercept an app running directly on macOS. ::: 1. Make sure Docker Desktop is running on macOS. @@ -269,7 +271,9 @@ curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss
:::info -You can run Keploy using **WSL** or **Docker** on Windows. +This page installs **Keploy OSS** (`install.sh --oss`), which intercepts with eBPF — Linux only — so on Windows you run it through **WSL** or **Docker**. + +Native Windows recording (x86-64, no WSL, no Docker, no Administrator) ships in the **Community** build, which is what the installer gives you when you drop `--oss`. See [Installing Keploy on Windows](/docs/installation/windows-installation/). ::: diff --git a/versioned_docs/version-4.0.0/running-keploy/mock-quickstart.md b/versioned_docs/version-4.0.0/running-keploy/mock-quickstart.md index 44eda4a422..7e5d725fdf 100644 --- a/versioned_docs/version-4.0.0/running-keploy/mock-quickstart.md +++ b/versioned_docs/version-4.0.0/running-keploy/mock-quickstart.md @@ -30,9 +30,11 @@ command shows the **real output** you should see — nothing is faked. keploy --version ``` -- **Linux** (root, for eBPF) or **Windows amd64** (Administrator). On - **macOS (Apple Silicon)**, run your tests through a docker command (shown at - the end). +- **Linux** (root, for eBPF), **Windows x86-64**, or **macOS (Apple Silicon)**. + Windows and macOS intercept in userspace in the Community build — the default + install — so neither needs Administrator or `sudo`. Running your tests through + a docker command (shown at the end) works on every platform, and is the route + on the OSS build (`--oss`), which is eBPF/Linux-only. - Python 3. (`go test` / `npm test` work identically — only the test command changes.) diff --git a/versioned_docs/version-4.0.0/running-keploy/mock-your-tests.md b/versioned_docs/version-4.0.0/running-keploy/mock-your-tests.md index 3e0e862ed7..d8ac03e3ac 100644 --- a/versioned_docs/version-4.0.0/running-keploy/mock-your-tests.md +++ b/versioned_docs/version-4.0.0/running-keploy/mock-your-tests.md @@ -166,9 +166,14 @@ test.afterEach(({}, testInfo) => post("/agent/scope/end", testInfo.title)); | Platform | How to run | | ------------------- | ------------------------------------------------------------------------- | -| **Linux** | Native — `keploy mock record -c "pytest"` (uses eBPF; needs root). | -| **Windows** (amd64) | Native — same command, from an Administrator shell. | -| **macOS** (arm64) | Run your tests through a container, e.g. `-c "docker compose run tests"`. | +| **Linux** | Native — `keploy mock record -c "pytest"` (uses eBPF; needs root). | +| **Windows** (x86-64) | Native — same command. Userspace interception, so no Administrator. | +| **macOS** (Apple Silicon) | Native — same command. Userspace interception, so no `sudo`. Running your tests in a container, e.g. `-c "docker compose run tests"`, also works. | + +Native macOS and Windows interception ships in the Community build, which is +what `https://keploy.io/install.sh` installs by default; the OSS build +(`--oss`) intercepts with eBPF and is Linux-only, so there you use a container +on both. ## Refresh in CI From 8783bb6aec43ab87e275e5041554b69d30bd4018 Mon Sep 17 00:00:00 2001 From: slayerjain Date: Tue, 22 Sep 2026 14:31:27 +0530 Subject: [PATCH 3/6] style(docs): run prettier on the platforms table Signed-off-by: slayerjain --- .../version-4.0.0/running-keploy/mock-your-tests.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/versioned_docs/version-4.0.0/running-keploy/mock-your-tests.md b/versioned_docs/version-4.0.0/running-keploy/mock-your-tests.md index d8ac03e3ac..ed3c634137 100644 --- a/versioned_docs/version-4.0.0/running-keploy/mock-your-tests.md +++ b/versioned_docs/version-4.0.0/running-keploy/mock-your-tests.md @@ -164,10 +164,10 @@ test.afterEach(({}, testInfo) => post("/agent/scope/end", testInfo.title)); ## Platforms -| Platform | How to run | -| ------------------- | ------------------------------------------------------------------------- | -| **Linux** | Native — `keploy mock record -c "pytest"` (uses eBPF; needs root). | -| **Windows** (x86-64) | Native — same command. Userspace interception, so no Administrator. | +| Platform | How to run | +| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | +| **Linux** | Native — `keploy mock record -c "pytest"` (uses eBPF; needs root). | +| **Windows** (x86-64) | Native — same command. Userspace interception, so no Administrator. | | **macOS** (Apple Silicon) | Native — same command. Userspace interception, so no `sudo`. Running your tests in a container, e.g. `-c "docker compose run tests"`, also works. | Native macOS and Windows interception ships in the Community build, which is From 4645e5ab30e80bb4265825653e21454bb0726cd3 Mon Sep 17 00:00:00 2001 From: slayerjain Date: Tue, 22 Sep 2026 14:37:21 +0530 Subject: [PATCH 4/6] docs: name the Community Edition wherever native macOS/Windows is mentioned Native macOS and Windows interception is a Community Edition feature, and which build a reader has decides whether the page applies to them. Every place that claims native support now names the edition and links to /docs/server/install/, so "Keploy runs natively" is never left meaning whichever build the reader happens to have. The two pages titled "Keploy on MacOS/Windows native" describe a Lima VM and WSL, which is the opposite of native; both now point at the real native route first and keep the VM route for the case it is actually for (an Intel Mac, or Windows/ARM). Signed-off-by: slayerjain --- versioned_docs/version-4.0.0/concepts/installation.md | 4 ++-- .../version-4.0.0/concepts/platform-requirements.md | 2 +- versioned_docs/version-4.0.0/installation/macos.md | 2 ++ versioned_docs/version-4.0.0/installation/windows.md | 2 ++ .../version-4.0.0/keploy-explained/dev-guide.md | 4 ++-- .../version-4.0.0/keploy-explained/mac-linux.md | 6 ++++++ .../version-4.0.0/keploy-explained/windows-wsl.md | 8 +++++++- .../version-4.0.0/running-keploy/mock-quickstart.md | 4 ++-- .../version-4.0.0/running-keploy/mock-your-tests.md | 4 ++-- versioned_docs/version-4.0.0/server/installation_tabs.md | 2 +- versioned_docs/version-4.0.0/server/macos/installation.md | 2 +- 11 files changed, 28 insertions(+), 12 deletions(-) diff --git a/versioned_docs/version-4.0.0/concepts/installation.md b/versioned_docs/version-4.0.0/concepts/installation.md index 7abe781e10..f7b30a8046 100644 --- a/versioned_docs/version-4.0.0/concepts/installation.md +++ b/versioned_docs/version-4.0.0/concepts/installation.md @@ -85,7 +85,7 @@ Use "keploy [command] --help" for more information about a command. #### On macOS/Windows -Note : With this method your application and Keploy's agent run in Docker, but the `keploy` CLI installed below — which starts them both — runs on your machine. On macOS that CLI is the native build, which is Apple Silicon (arm64) only — on an Intel Mac, run Keploy with [Lima](/docs/installation/macos-installation/#option-2-install-keploy-with-lima) instead. +Note : With this method your application and Keploy's agent run in Docker, but the `keploy` CLI installed below — which starts them both — runs on your machine. On macOS that CLI is the native build from the **[Keploy Community Edition](/docs/server/install/)**, which is Apple Silicon (arm64) only — on an Intel Mac, run Keploy with [Lima](/docs/installation/macos-installation/#option-2-install-keploy-with-lima) instead. 1. Open up a terminal window. @@ -151,7 +151,7 @@ sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin/keploy ``` -> Note: On macOS, Keploy's native CLI is Apple Silicon (arm64) only — see [Installing Keploy on macOS](/docs/installation/macos-installation/). On an Intel Mac, run Keploy with [Lima](/docs/installation/macos-installation/#option-2-install-keploy-with-lima), which installs the Linux build above inside the VM. +> Note: On macOS, Keploy's native CLI — the **[Keploy Community Edition](/docs/server/install/)** — is Apple Silicon (arm64) only — see [Installing Keploy on macOS](/docs/installation/macos-installation/). On an Intel Mac, run Keploy with [Lima](/docs/installation/macos-installation/#option-2-install-keploy-with-lima), which installs the Linux build above inside the VM. **_Setting up the Docker Desktop for WSL 2_** diff --git a/versioned_docs/version-4.0.0/concepts/platform-requirements.md b/versioned_docs/version-4.0.0/concepts/platform-requirements.md index 8f04135902..9a540d4e14 100644 --- a/versioned_docs/version-4.0.0/concepts/platform-requirements.md +++ b/versioned_docs/version-4.0.0/concepts/platform-requirements.md @@ -32,4 +32,4 @@ Linux: | Windows **Windows** | Supported Native, x86‑64 (Go, Node, Python, Java) | [Guide](/server/install/) | - Use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install#install-wsl-command) `wsl --install`
- Windows 10 version 2004 and higher (Build 19041 and higher) or Windows 11
- Ensure that Docker Desktop version 4.25.2 or above is installed if you are following the Docker installation guide | | Linux **Linux** | Supported | Supported | Linux kernel 5.15 or higher | -Keploy runs natively on macOS (Apple Silicon / arm64) and Windows (x86‑64) in the Community and Enterprise builds — which is what `https://keploy.io/install.sh` installs by default. Neither platform has eBPF, so Keploy intercepts traffic in userspace on both, and neither needs `sudo` or Administrator. (The OSS build, `install.sh --oss`, intercepts with eBPF and records a natively-running app on Linux only; on macOS and Windows it works through Docker.) Docker, Lima (macOS) and WSL (Windows) remain supported alternatives, and are still the route on Windows/ARM. On an Intel Mac use Lima: the Docker route on macOS still runs the native CLI on the host, so it is Apple Silicon only too. +Keploy runs natively on macOS (Apple Silicon / arm64) and Windows (x86‑64) in the **[Keploy Community Edition](/docs/server/install/)** and Enterprise builds — which is what `https://keploy.io/install.sh` installs by default. Neither platform has eBPF, so Keploy intercepts traffic in userspace on both, and neither needs `sudo` or Administrator. (The OSS build, `install.sh --oss`, intercepts with eBPF and records a natively-running app on Linux only; on macOS and Windows it works through Docker.) Docker, Lima (macOS) and WSL (Windows) remain supported alternatives, and are still the route on Windows/ARM. On an Intel Mac use Lima: the Docker route on macOS still runs the native CLI on the host, so it is Apple Silicon only too. diff --git a/versioned_docs/version-4.0.0/installation/macos.md b/versioned_docs/version-4.0.0/installation/macos.md index 5ab83689d9..bb76f1a8da 100644 --- a/versioned_docs/version-4.0.0/installation/macos.md +++ b/versioned_docs/version-4.0.0/installation/macos.md @@ -17,6 +17,8 @@ keywords: Keploy now runs **natively on macOS** (Apple Silicon) — you can record and replay an app that runs directly on your Mac, with no Lima VM and no Docker. Native macOS support intercepts traffic in userspace (there is no eBPF on macOS), so it needs no root and installs nothing system-wide. +Native macOS interception ships in the **[Keploy Community Edition](/docs/server/install/)**, which is what the install command below gives you by default. (`install.sh --oss` selects the OSS build instead, which intercepts with eBPF and is Linux-only.) + Native macOS support covers **Go, Node.js, Python and Java** apps, including their HTTPS traffic. Docker and Lima remain available if you prefer to run your app in a container. :::note Keploy Community needs a free account diff --git a/versioned_docs/version-4.0.0/installation/windows.md b/versioned_docs/version-4.0.0/installation/windows.md index 2d0b30bdfe..dc1c37d8a8 100644 --- a/versioned_docs/version-4.0.0/installation/windows.md +++ b/versioned_docs/version-4.0.0/installation/windows.md @@ -17,6 +17,8 @@ keywords: # Installing Keploy on Windows +Native Windows interception ships in the **[Keploy Community Edition](/docs/server/install/)**, which is what the routes below install by default. (`install.sh --oss` selects the OSS build instead, which intercepts with eBPF and is Linux-only.) + 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. diff --git a/versioned_docs/version-4.0.0/keploy-explained/dev-guide.md b/versioned_docs/version-4.0.0/keploy-explained/dev-guide.md index 6e8c6c52f3..36f2799a91 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/dev-guide.md +++ b/versioned_docs/version-4.0.0/keploy-explained/dev-guide.md @@ -201,7 +201,7 @@ curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss :::info This page installs **Keploy OSS** (`install.sh --oss`), which intercepts traffic with eBPF — Linux only. It has no native macOS backend, so on a Mac you run it through **Lima** or **Docker**. -Native macOS recording — your app running directly on your Mac, no VM and no containers — ships in the **Community** build, which is what the installer gives you when you drop `--oss`. See [Installing Keploy on macOS](/docs/installation/macos-installation/). That build is Apple Silicon (arm64) only. +Native macOS recording — your app running directly on your Mac, no VM and no containers — ships in the **[Keploy Community Edition](/docs/server/install/)**, which is what the installer gives you when you drop `--oss`. See [Installing Keploy on macOS](/docs/installation/macos-installation/). That build is Apple Silicon (arm64) only. ::: @@ -273,7 +273,7 @@ curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss :::info This page installs **Keploy OSS** (`install.sh --oss`), which intercepts with eBPF — Linux only — so on Windows you run it through **WSL** or **Docker**. -Native Windows recording (x86-64, no WSL, no Docker, no Administrator) ships in the **Community** build, which is what the installer gives you when you drop `--oss`. See [Installing Keploy on Windows](/docs/installation/windows-installation/). +Native Windows recording (x86-64, no WSL, no Docker, no Administrator) ships in the **[Keploy Community Edition](/docs/server/install/)**, which is what the installer gives you when you drop `--oss`. See [Installing Keploy on Windows](/docs/installation/windows-installation/). ::: diff --git a/versioned_docs/version-4.0.0/keploy-explained/mac-linux.md b/versioned_docs/version-4.0.0/keploy-explained/mac-linux.md index 60006a0268..68aa4ebc50 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/mac-linux.md +++ b/versioned_docs/version-4.0.0/keploy-explained/mac-linux.md @@ -9,6 +9,12 @@ description: "Run Keploy natively on macOS by setting up a Debian Linux VM with **_Downloading and running Keploy in Native using Debian on MacOS_** +:::tip Looking for true native macOS? + +This page runs Keploy inside a Debian VM, which is the route for an **Intel Mac**. On Apple Silicon you can skip the VM: the **[Keploy Community Edition](/docs/server/install/)** records an app running directly on your Mac, with no Lima and no Docker — see [Installing Keploy on macOS](/docs/installation/macos-installation/). + +::: + 1. Open the terminal Session. 2. Run the following command. This installs homebrew and makes it easier to manage software and packages on macOS diff --git a/versioned_docs/version-4.0.0/keploy-explained/windows-wsl.md b/versioned_docs/version-4.0.0/keploy-explained/windows-wsl.md index 0dddd109a3..a2911512af 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/windows-wsl.md +++ b/versioned_docs/version-4.0.0/keploy-explained/windows-wsl.md @@ -31,7 +31,13 @@ steps={[ visible={false} /> -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. +The Keploy build described here 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 it 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. + +:::tip WSL is not the only option + +the **[Keploy Community Edition](/docs/server/install/)** intercepts in userspace on Windows and records an app running directly on Windows (x86-64) — no WSL, no Docker and no Administrator. See [Installing Keploy on Windows](/docs/installation/windows-installation/). Use WSL if you are on Windows/ARM, or if you want the eBPF build. + +::: ## Prerequisites diff --git a/versioned_docs/version-4.0.0/running-keploy/mock-quickstart.md b/versioned_docs/version-4.0.0/running-keploy/mock-quickstart.md index 7e5d725fdf..96fdab1f91 100644 --- a/versioned_docs/version-4.0.0/running-keploy/mock-quickstart.md +++ b/versioned_docs/version-4.0.0/running-keploy/mock-quickstart.md @@ -31,8 +31,8 @@ command shows the **real output** you should see — nothing is faked. ``` - **Linux** (root, for eBPF), **Windows x86-64**, or **macOS (Apple Silicon)**. - Windows and macOS intercept in userspace in the Community build — the default - install — so neither needs Administrator or `sudo`. Running your tests through + Windows and macOS intercept in userspace in the **[Keploy Community Edition](/docs/server/install/)** + — the default install — so neither needs Administrator or `sudo`. Running your tests through a docker command (shown at the end) works on every platform, and is the route on the OSS build (`--oss`), which is eBPF/Linux-only. - Python 3. (`go test` / `npm test` work identically — only the test command diff --git a/versioned_docs/version-4.0.0/running-keploy/mock-your-tests.md b/versioned_docs/version-4.0.0/running-keploy/mock-your-tests.md index ed3c634137..fd6cd05a7a 100644 --- a/versioned_docs/version-4.0.0/running-keploy/mock-your-tests.md +++ b/versioned_docs/version-4.0.0/running-keploy/mock-your-tests.md @@ -170,8 +170,8 @@ test.afterEach(({}, testInfo) => post("/agent/scope/end", testInfo.title)); | **Windows** (x86-64) | Native — same command. Userspace interception, so no Administrator. | | **macOS** (Apple Silicon) | Native — same command. Userspace interception, so no `sudo`. Running your tests in a container, e.g. `-c "docker compose run tests"`, also works. | -Native macOS and Windows interception ships in the Community build, which is -what `https://keploy.io/install.sh` installs by default; the OSS build +Native macOS and Windows interception ships in the **[Keploy Community Edition](/docs/server/install/)**, +which is what `https://keploy.io/install.sh` installs by default; the OSS build (`--oss`) intercepts with eBPF and is Linux-only, so there you use a container on both. diff --git a/versioned_docs/version-4.0.0/server/installation_tabs.md b/versioned_docs/version-4.0.0/server/installation_tabs.md index 3cadf93265..28e524d244 100644 --- a/versioned_docs/version-4.0.0/server/installation_tabs.md +++ b/versioned_docs/version-4.0.0/server/installation_tabs.md @@ -230,7 +230,7 @@ Use "keploy [command] --help" for more information about a command.
:::info -Keploy runs natively on Apple Silicon Macs (Go, Node, Python and Java apps). You can also run it using **Lima** or **Docker**. The native CLI is Apple Silicon (arm64) only and the Docker method still runs it on your Mac, so on an Intel Mac use **Lima**. +Keploy runs natively on Apple Silicon Macs (Go, Node, Python and Java apps) with the **[Keploy Community Edition](/docs/server/install/)**, the default install. You can also run it using **Lima** or **Docker**. The native CLI is Apple Silicon (arm64) only and the Docker method still runs it on your Mac, so on an Intel Mac use **Lima**. ::: 👉 **Choose your preferred method:** diff --git a/versioned_docs/version-4.0.0/server/macos/installation.md b/versioned_docs/version-4.0.0/server/macos/installation.md index 795cdc0f6a..ac74e2ae7b 100644 --- a/versioned_docs/version-4.0.0/server/macos/installation.md +++ b/versioned_docs/version-4.0.0/server/macos/installation.md @@ -57,7 +57,7 @@ For users who need eBPF support, a [manual setup with Docker Desktop or Colima]( :::note Apple Silicon only -Both routes install the native Keploy CLI, which is built for **Apple Silicon (arm64) only** — the installer stops with a message on an Intel Mac, and the Homebrew formula refuses to install there. The [manual Docker Desktop / Colima setup](#manual-setup) below is driven by that same CLI: it starts your app and Keploy's eBPF agent in containers inside the Linux VM, but the CLI itself runs on your Mac, so that route is Apple Silicon only too. On an Intel Mac, run Keploy with [Lima](/docs/installation/macos-installation/#option-2-install-keploy-with-lima) instead. +Both routes install the native Keploy CLI — the **[Keploy Community Edition](/docs/server/install/)**, the default install — which is built for **Apple Silicon (arm64) only** — the installer stops with a message on an Intel Mac, and the Homebrew formula refuses to install there. The [manual Docker Desktop / Colima setup](#manual-setup) below is driven by that same CLI: it starts your app and Keploy's eBPF agent in containers inside the Linux VM, but the CLI itself runs on your Mac, so that route is Apple Silicon only too. On an Intel Mac, run Keploy with [Lima](/docs/installation/macos-installation/#option-2-install-keploy-with-lima) instead. ::: From 967c4146188beeac152312a3fbefd233eebf3f54 Mon Sep 17 00:00:00 2001 From: slayerjain Date: Tue, 22 Sep 2026 14:41:55 +0530 Subject: [PATCH 5/6] =?UTF-8?q?docs:=20it=20is=20just=20"keploy"=20?= =?UTF-8?q?=E2=80=94=20drop=20the=20edition=20qualifiers?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The docs describe one binary, keploy, and do not ask the reader to sort out OSS vs Community vs Enterprise. The previous two commits had started doing exactly that — "ships in the Community Edition", "the OSS build (--oss) is Linux-only" — on every page that mentions native macOS or Windows. Gone: Keploy runs natively on macOS (Apple Silicon) and Windows (x86-64), full stop. The Windows page's pre-existing warning about the GitHub release asset keeps its point (that build refuses a native Windows run) without the edition vocabulary. The Contribution Guide still documents the open-source build, since that is what a contributor builds, but it no longer contrasts it with an edition — it says what that build does and links the native guides. Signed-off-by: slayerjain --- versioned_docs/version-4.0.0/concepts/installation.md | 4 ++-- .../version-4.0.0/concepts/platform-requirements.md | 2 +- versioned_docs/version-4.0.0/installation/macos.md | 2 -- versioned_docs/version-4.0.0/installation/windows.md | 4 +--- .../version-4.0.0/keploy-explained/dev-guide.md | 10 +++------- .../version-4.0.0/keploy-explained/mac-linux.md | 2 +- .../version-4.0.0/keploy-explained/windows-wsl.md | 4 ++-- .../version-4.0.0/running-keploy/mock-quickstart.md | 7 +++---- .../version-4.0.0/running-keploy/mock-your-tests.md | 5 ----- .../version-4.0.0/server/installation_tabs.md | 2 +- .../version-4.0.0/server/macos/installation.md | 2 +- 11 files changed, 15 insertions(+), 29 deletions(-) diff --git a/versioned_docs/version-4.0.0/concepts/installation.md b/versioned_docs/version-4.0.0/concepts/installation.md index f7b30a8046..7abe781e10 100644 --- a/versioned_docs/version-4.0.0/concepts/installation.md +++ b/versioned_docs/version-4.0.0/concepts/installation.md @@ -85,7 +85,7 @@ Use "keploy [command] --help" for more information about a command. #### On macOS/Windows -Note : With this method your application and Keploy's agent run in Docker, but the `keploy` CLI installed below — which starts them both — runs on your machine. On macOS that CLI is the native build from the **[Keploy Community Edition](/docs/server/install/)**, which is Apple Silicon (arm64) only — on an Intel Mac, run Keploy with [Lima](/docs/installation/macos-installation/#option-2-install-keploy-with-lima) instead. +Note : With this method your application and Keploy's agent run in Docker, but the `keploy` CLI installed below — which starts them both — runs on your machine. On macOS that CLI is the native build, which is Apple Silicon (arm64) only — on an Intel Mac, run Keploy with [Lima](/docs/installation/macos-installation/#option-2-install-keploy-with-lima) instead. 1. Open up a terminal window. @@ -151,7 +151,7 @@ sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin/keploy ``` -> Note: On macOS, Keploy's native CLI — the **[Keploy Community Edition](/docs/server/install/)** — is Apple Silicon (arm64) only — see [Installing Keploy on macOS](/docs/installation/macos-installation/). On an Intel Mac, run Keploy with [Lima](/docs/installation/macos-installation/#option-2-install-keploy-with-lima), which installs the Linux build above inside the VM. +> Note: On macOS, Keploy's native CLI is Apple Silicon (arm64) only — see [Installing Keploy on macOS](/docs/installation/macos-installation/). On an Intel Mac, run Keploy with [Lima](/docs/installation/macos-installation/#option-2-install-keploy-with-lima), which installs the Linux build above inside the VM. **_Setting up the Docker Desktop for WSL 2_** diff --git a/versioned_docs/version-4.0.0/concepts/platform-requirements.md b/versioned_docs/version-4.0.0/concepts/platform-requirements.md index 9a540d4e14..f862effb9d 100644 --- a/versioned_docs/version-4.0.0/concepts/platform-requirements.md +++ b/versioned_docs/version-4.0.0/concepts/platform-requirements.md @@ -32,4 +32,4 @@ Linux: | Windows **Windows** | Supported Native, x86‑64 (Go, Node, Python, Java) | [Guide](/server/install/) | - Use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install#install-wsl-command) `wsl --install`
- Windows 10 version 2004 and higher (Build 19041 and higher) or Windows 11
- Ensure that Docker Desktop version 4.25.2 or above is installed if you are following the Docker installation guide | | Linux **Linux** | Supported | Supported | Linux kernel 5.15 or higher | -Keploy runs natively on macOS (Apple Silicon / arm64) and Windows (x86‑64) in the **[Keploy Community Edition](/docs/server/install/)** and Enterprise builds — which is what `https://keploy.io/install.sh` installs by default. Neither platform has eBPF, so Keploy intercepts traffic in userspace on both, and neither needs `sudo` or Administrator. (The OSS build, `install.sh --oss`, intercepts with eBPF and records a natively-running app on Linux only; on macOS and Windows it works through Docker.) Docker, Lima (macOS) and WSL (Windows) remain supported alternatives, and are still the route on Windows/ARM. On an Intel Mac use Lima: the Docker route on macOS still runs the native CLI on the host, so it is Apple Silicon only too. +Keploy runs natively on macOS (Apple Silicon / arm64) and Windows (x86‑64) — neither has eBPF, so it intercepts traffic in userspace on both, and neither needs `sudo` or Administrator. Docker, Lima (macOS) and WSL (Windows) remain supported alternatives, and are still the route on Windows/ARM. On an Intel Mac use Lima: the Docker route on macOS still runs the native CLI on the host, so it is Apple Silicon only too. diff --git a/versioned_docs/version-4.0.0/installation/macos.md b/versioned_docs/version-4.0.0/installation/macos.md index bb76f1a8da..5ab83689d9 100644 --- a/versioned_docs/version-4.0.0/installation/macos.md +++ b/versioned_docs/version-4.0.0/installation/macos.md @@ -17,8 +17,6 @@ keywords: Keploy now runs **natively on macOS** (Apple Silicon) — you can record and replay an app that runs directly on your Mac, with no Lima VM and no Docker. Native macOS support intercepts traffic in userspace (there is no eBPF on macOS), so it needs no root and installs nothing system-wide. -Native macOS interception ships in the **[Keploy Community Edition](/docs/server/install/)**, which is what the install command below gives you by default. (`install.sh --oss` selects the OSS build instead, which intercepts with eBPF and is Linux-only.) - Native macOS support covers **Go, Node.js, Python and Java** apps, including their HTTPS traffic. Docker and Lima remain available if you prefer to run your app in a container. :::note Keploy Community needs a free account diff --git a/versioned_docs/version-4.0.0/installation/windows.md b/versioned_docs/version-4.0.0/installation/windows.md index dc1c37d8a8..272658f216 100644 --- a/versioned_docs/version-4.0.0/installation/windows.md +++ b/versioned_docs/version-4.0.0/installation/windows.md @@ -17,8 +17,6 @@ keywords: # Installing Keploy on Windows -Native Windows interception ships in the **[Keploy Community Edition](/docs/server/install/)**, which is what the routes below install by default. (`install.sh --oss` selects the OSS build instead, which intercepts with eBPF and is Linux-only.) - 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. @@ -68,7 +66,7 @@ A free account is enough to record and replay. Free-tier runs are subject to a u Open a new terminal so the updated `Path` takes effect, then check it with `keploy --version`. - **Use the Community build for native Windows.** Native Windows interception ships in the Community build that both routes above install. Its download is named `enterprise_windows_amd64.exe` for historical reasons — a free account is all you need. The `keploy_windows_amd64` asset on the [GitHub releases page](https://github.com/keploy/keploy/releases) is a different, OSS build that intercepts with eBPF and so refuses a native Windows run with _"not supported by this build of Keploy"_. Use that asset only if you are running Keploy inside Docker. + **Use the download above, not the GitHub release asset.** The Windows binary is named `enterprise_windows_amd64.exe` for historical reasons — a free account is all you need. The `keploy_windows_amd64` asset on the [GitHub releases page](https://github.com/keploy/keploy/releases) is a different build that intercepts with eBPF and so refuses a native Windows run with _"not supported by this build of Keploy"_; it is only for running Keploy inside Docker. **If Windows blocks the download.** The Windows build is not yet code-signed, so SmartScreen may show "Windows protected your PC" on first run. The `Unblock-File` line above clears the download marker; if you fetched the binary another way, right-click it, choose **Properties**, and tick **Unblock**. diff --git a/versioned_docs/version-4.0.0/keploy-explained/dev-guide.md b/versioned_docs/version-4.0.0/keploy-explained/dev-guide.md index 36f2799a91..1dbafa6707 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/dev-guide.md +++ b/versioned_docs/version-4.0.0/keploy-explained/dev-guide.md @@ -199,9 +199,7 @@ curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss
:::info -This page installs **Keploy OSS** (`install.sh --oss`), which intercepts traffic with eBPF — Linux only. It has no native macOS backend, so on a Mac you run it through **Lima** or **Docker**. - -Native macOS recording — your app running directly on your Mac, no VM and no containers — ships in the **[Keploy Community Edition](/docs/server/install/)**, which is what the installer gives you when you drop `--oss`. See [Installing Keploy on macOS](/docs/installation/macos-installation/). That build is Apple Silicon (arm64) only. +The open-source build intercepts traffic with eBPF, which is Linux-only, so on a Mac you run it through **Lima** or **Docker**. (To record an app running directly on your Mac instead, see [Installing Keploy on macOS](/docs/installation/macos-installation/).) ::: @@ -250,7 +248,7 @@ curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss ### Install Keploy OSS with Docker on macOS :::note -Your application and Keploy's agent both run in containers here, which is what makes this work on a Mac at all: the OSS build cannot intercept an app running directly on macOS. +Your application and Keploy's agent both run in containers here — the open-source build intercepts with eBPF, so on a Mac the app has to be in a container for it to see the traffic. ::: 1. Make sure Docker Desktop is running on macOS. @@ -271,9 +269,7 @@ curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss
:::info -This page installs **Keploy OSS** (`install.sh --oss`), which intercepts with eBPF — Linux only — so on Windows you run it through **WSL** or **Docker**. - -Native Windows recording (x86-64, no WSL, no Docker, no Administrator) ships in the **[Keploy Community Edition](/docs/server/install/)**, which is what the installer gives you when you drop `--oss`. See [Installing Keploy on Windows](/docs/installation/windows-installation/). +The open-source build intercepts with eBPF, which is Linux-only, so on Windows you run it through **WSL** or **Docker**. (To record an app running directly on Windows instead, see [Installing Keploy on Windows](/docs/installation/windows-installation/).) ::: diff --git a/versioned_docs/version-4.0.0/keploy-explained/mac-linux.md b/versioned_docs/version-4.0.0/keploy-explained/mac-linux.md index 68aa4ebc50..8495196bf7 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/mac-linux.md +++ b/versioned_docs/version-4.0.0/keploy-explained/mac-linux.md @@ -11,7 +11,7 @@ description: "Run Keploy natively on macOS by setting up a Debian Linux VM with :::tip Looking for true native macOS? -This page runs Keploy inside a Debian VM, which is the route for an **Intel Mac**. On Apple Silicon you can skip the VM: the **[Keploy Community Edition](/docs/server/install/)** records an app running directly on your Mac, with no Lima and no Docker — see [Installing Keploy on macOS](/docs/installation/macos-installation/). +This page runs Keploy inside a Debian VM, which is the route for an **Intel Mac**. On Apple Silicon you can skip the VM: Keploy records an app running directly on your Mac, with no Lima and no Docker — see [Installing Keploy on macOS](/docs/installation/macos-installation/). ::: diff --git a/versioned_docs/version-4.0.0/keploy-explained/windows-wsl.md b/versioned_docs/version-4.0.0/keploy-explained/windows-wsl.md index a2911512af..e25cf01cf8 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/windows-wsl.md +++ b/versioned_docs/version-4.0.0/keploy-explained/windows-wsl.md @@ -31,11 +31,11 @@ steps={[ visible={false} /> -The Keploy build described here 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 it 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. +Inside WSL, Keploy uses the Linux kernel's eBPF subsystem to capture network traffic. **WSL (Windows Subsystem for Linux)** 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. :::tip WSL is not the only option -the **[Keploy Community Edition](/docs/server/install/)** intercepts in userspace on Windows and records an app running directly on Windows (x86-64) — no WSL, no Docker and no Administrator. See [Installing Keploy on Windows](/docs/installation/windows-installation/). Use WSL if you are on Windows/ARM, or if you want the eBPF build. +Keploy also records an app running directly on Windows (x86-64) — no WSL, no Docker and no Administrator. See [Installing Keploy on Windows](/docs/installation/windows-installation/). WSL is the route on Windows/ARM. ::: diff --git a/versioned_docs/version-4.0.0/running-keploy/mock-quickstart.md b/versioned_docs/version-4.0.0/running-keploy/mock-quickstart.md index 96fdab1f91..664ba9f38e 100644 --- a/versioned_docs/version-4.0.0/running-keploy/mock-quickstart.md +++ b/versioned_docs/version-4.0.0/running-keploy/mock-quickstart.md @@ -31,10 +31,9 @@ command shows the **real output** you should see — nothing is faked. ``` - **Linux** (root, for eBPF), **Windows x86-64**, or **macOS (Apple Silicon)**. - Windows and macOS intercept in userspace in the **[Keploy Community Edition](/docs/server/install/)** - — the default install — so neither needs Administrator or `sudo`. Running your tests through - a docker command (shown at the end) works on every platform, and is the route - on the OSS build (`--oss`), which is eBPF/Linux-only. + Windows and macOS intercept in userspace, so neither needs Administrator or + `sudo`. Running your tests through a docker command (shown at the end) works + on every platform. - Python 3. (`go test` / `npm test` work identically — only the test command changes.) diff --git a/versioned_docs/version-4.0.0/running-keploy/mock-your-tests.md b/versioned_docs/version-4.0.0/running-keploy/mock-your-tests.md index fd6cd05a7a..1a87037c89 100644 --- a/versioned_docs/version-4.0.0/running-keploy/mock-your-tests.md +++ b/versioned_docs/version-4.0.0/running-keploy/mock-your-tests.md @@ -170,11 +170,6 @@ test.afterEach(({}, testInfo) => post("/agent/scope/end", testInfo.title)); | **Windows** (x86-64) | Native — same command. Userspace interception, so no Administrator. | | **macOS** (Apple Silicon) | Native — same command. Userspace interception, so no `sudo`. Running your tests in a container, e.g. `-c "docker compose run tests"`, also works. | -Native macOS and Windows interception ships in the **[Keploy Community Edition](/docs/server/install/)**, -which is what `https://keploy.io/install.sh` installs by default; the OSS build -(`--oss`) intercepts with eBPF and is Linux-only, so there you use a container -on both. - ## Refresh in CI Because re-recording overwrites the set in place and the runner's exit code is diff --git a/versioned_docs/version-4.0.0/server/installation_tabs.md b/versioned_docs/version-4.0.0/server/installation_tabs.md index 28e524d244..3cadf93265 100644 --- a/versioned_docs/version-4.0.0/server/installation_tabs.md +++ b/versioned_docs/version-4.0.0/server/installation_tabs.md @@ -230,7 +230,7 @@ Use "keploy [command] --help" for more information about a command.
:::info -Keploy runs natively on Apple Silicon Macs (Go, Node, Python and Java apps) with the **[Keploy Community Edition](/docs/server/install/)**, the default install. You can also run it using **Lima** or **Docker**. The native CLI is Apple Silicon (arm64) only and the Docker method still runs it on your Mac, so on an Intel Mac use **Lima**. +Keploy runs natively on Apple Silicon Macs (Go, Node, Python and Java apps). You can also run it using **Lima** or **Docker**. The native CLI is Apple Silicon (arm64) only and the Docker method still runs it on your Mac, so on an Intel Mac use **Lima**. ::: 👉 **Choose your preferred method:** diff --git a/versioned_docs/version-4.0.0/server/macos/installation.md b/versioned_docs/version-4.0.0/server/macos/installation.md index ac74e2ae7b..795cdc0f6a 100644 --- a/versioned_docs/version-4.0.0/server/macos/installation.md +++ b/versioned_docs/version-4.0.0/server/macos/installation.md @@ -57,7 +57,7 @@ For users who need eBPF support, a [manual setup with Docker Desktop or Colima]( :::note Apple Silicon only -Both routes install the native Keploy CLI — the **[Keploy Community Edition](/docs/server/install/)**, the default install — which is built for **Apple Silicon (arm64) only** — the installer stops with a message on an Intel Mac, and the Homebrew formula refuses to install there. The [manual Docker Desktop / Colima setup](#manual-setup) below is driven by that same CLI: it starts your app and Keploy's eBPF agent in containers inside the Linux VM, but the CLI itself runs on your Mac, so that route is Apple Silicon only too. On an Intel Mac, run Keploy with [Lima](/docs/installation/macos-installation/#option-2-install-keploy-with-lima) instead. +Both routes install the native Keploy CLI, which is built for **Apple Silicon (arm64) only** — the installer stops with a message on an Intel Mac, and the Homebrew formula refuses to install there. The [manual Docker Desktop / Colima setup](#manual-setup) below is driven by that same CLI: it starts your app and Keploy's eBPF agent in containers inside the Linux VM, but the CLI itself runs on your Mac, so that route is Apple Silicon only too. On an Intel Mac, run Keploy with [Lima](/docs/installation/macos-installation/#option-2-install-keploy-with-lima) instead. ::: From 6a516bad85eba84441881a1fc1bbb513d66395c8 Mon Sep 17 00:00:00 2001 From: slayerjain Date: Tue, 22 Sep 2026 14:44:53 +0530 Subject: [PATCH 6/6] docs(contribution-guide): install keploy, not an "open-source build" MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The previous commit kept "the open-source build intercepts with eBPF" in the Contribution Guide on the grounds that a contributor builds that repository. That is still an edition distinction, and the docs do not make one: there is one keploy. The section now installs it with the same command as every other page (no --oss), its headings say "Install Keploy with Lima/Docker/WSL", and its macOS and Windows tabs say what the installation pages say — native on Apple Silicon and Windows x86-64, with Lima/Docker/WSL as the alternatives and the Intel/ARM routes. Signed-off-by: slayerjain --- .../keploy-explained/dev-guide.md | 46 +++++++++---------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/versioned_docs/version-4.0.0/keploy-explained/dev-guide.md b/versioned_docs/version-4.0.0/keploy-explained/dev-guide.md index 1dbafa6707..d25c844c9e 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/dev-guide.md +++ b/versioned_docs/version-4.0.0/keploy-explained/dev-guide.md @@ -114,9 +114,9 @@ Happy testing! 🧪🔍💻 Hope this helps you out, if you still have any questions, reach out to us on [Slack](https://keploy.io/slack). -## Installing the Open Source Build +## Installing Keploy -To install the open-source version of Keploy, use the `--oss` flag: +To install the released Keploy binary alongside your local build: import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -139,7 +139,7 @@ Make sure your Linux kernel version is **5.10 or higher**. ### 1. Install Keploy ```bash -curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss +curl --silent -O -L https://keploy.io/install.sh && source install.sh ``` ### 2. Once done, you should see something like this: @@ -172,23 +172,23 @@ Flags: Use "keploy [command] --help" for more information about a command. ``` -🎉 You have successfully installed **Keploy OSS on Linux**. +🎉 You have successfully installed **Keploy on Linux**. -### Install Keploy OSS with Docker on Linux +### Install Keploy with Docker on Linux 1. Make sure Docker is installed on Linux. 2. Install Keploy ```bash -curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss +curl --silent -O -L https://keploy.io/install.sh && source install.sh ``` -🎉 You have successfully set up **Keploy OSS on Linux** using **Docker**. +🎉 You have successfully set up **Keploy on Linux** using **Docker**. @@ -199,13 +199,13 @@ curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss
:::info -The open-source build intercepts traffic with eBPF, which is Linux-only, so on a Mac you run it through **Lima** or **Docker**. (To record an app running directly on your Mac instead, see [Installing Keploy on macOS](/docs/installation/macos-installation/).) +Keploy runs natively on Apple Silicon Macs (Go, Node, Python and Java apps) — see [Installing Keploy on macOS](/docs/installation/macos-installation/). You can also run it using **Lima** or **Docker**. The native CLI is Apple Silicon (arm64) only and the Docker method still runs it on your Mac, so on an Intel Mac use **Lima**. ::: -### Install Keploy OSS with Lima +### Install Keploy with Lima 1. Check if Lima is installed. If yes, skip to step 6. 2. Install Lima @@ -235,30 +235,30 @@ limactl shell debian-12 6. Install Keploy inside Lima ```bash -curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss +curl --silent -O -L https://keploy.io/install.sh && source install.sh ``` -🎉 You have successfully set up **Keploy OSS on macOS** using **Lima**. +🎉 You have successfully set up **Keploy on macOS** using **Lima**. -### Install Keploy OSS with Docker on macOS +### Install Keploy with Docker on macOS -:::note -Your application and Keploy's agent both run in containers here — the open-source build intercepts with eBPF, so on a Mac the app has to be in a container for it to see the traffic. +:::note Apple Silicon only +Your application and Keploy's agent run in containers here, but the `keploy` CLI installed in step 2 — which starts them both — is the native macOS build, which is Apple Silicon (arm64) only. On an Intel Mac use the **Lima** tab instead. ::: 1. Make sure Docker Desktop is running on macOS. 2. Install Keploy ```bash -curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss +curl --silent -O -L https://keploy.io/install.sh && source install.sh ``` -🎉 You have successfully set up **Keploy OSS on macOS** using **Docker**. +🎉 You have successfully set up **Keploy on macOS** using **Docker**. @@ -269,13 +269,13 @@ curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss
:::info -The open-source build intercepts with eBPF, which is Linux-only, so on Windows you run it through **WSL** or **Docker**. (To record an app running directly on Windows instead, see [Installing Keploy on Windows](/docs/installation/windows-installation/).) +Keploy runs natively on Windows (x86-64) with no WSL, no Docker and no Administrator — see [Installing Keploy on Windows](/docs/installation/windows-installation/). You can also run it using **WSL** or **Docker**, which remain the route on Windows/ARM. ::: -### Install Keploy OSS with WSL +### Install Keploy with WSL 1. Enable WSL @@ -288,26 +288,26 @@ wsl --install -d 2. Install Keploy inside WSL ```shell -curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss +curl --silent -O -L https://keploy.io/install.sh && source install.sh ``` -🎉 You have successfully set up **Keploy OSS on Windows** using **WSL**. +🎉 You have successfully set up **Keploy on Windows** using **WSL**. -### Install Keploy OSS with Docker on Windows +### Install Keploy with Docker on Windows 1. Make sure Docker Desktop is running on Windows. 2. Install Keploy ```bash -curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss +curl --silent -O -L https://keploy.io/install.sh && source install.sh ``` -🎉 You have successfully set up **Keploy OSS on Windows** using **Docker**. +🎉 You have successfully set up **Keploy on Windows** using **Docker**.