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/installation/windows.md b/versioned_docs/version-4.0.0/installation/windows.md index 2d0b30bdfe..272658f216 100644 --- a/versioned_docs/version-4.0.0/installation/windows.md +++ b/versioned_docs/version-4.0.0/installation/windows.md @@ -66,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 6ada5145dd..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 -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) — 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,26 +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 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**. @@ -265,13 +269,13 @@ curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss
:::info -You can run Keploy using **WSL** or **Docker** on Windows. +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 @@ -284,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**. 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..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 @@ -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: Keploy 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 @@ -46,7 +52,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/keploy-explained/windows-wsl.md b/versioned_docs/version-4.0.0/keploy-explained/windows-wsl.md index 0dddd109a3..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,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. +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 + +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. + +::: ## 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 a06ef1a3c5..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 @@ -30,8 +30,10 @@ 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), **Windows x86-64**, or **macOS (Apple Silicon)**. + 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 3e0e862ed7..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 @@ -164,11 +164,11 @@ 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** (amd64) | Native — same command, from an Administrator shell. | -| **macOS** (arm64) | Run your tests through a container, e.g. `-c "docker compose run tests"`. | +| 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. | ## Refresh in CI 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: