From 2e8789cb85a22f66b94d20608fe8b958060c0257 Mon Sep 17 00:00:00 2001 From: slayerjain Date: Fri, 20 Nov 2026 12:43:26 +0530 Subject: [PATCH] docs: list the calls Keploy 3.9.4 understands natively on macOS The platform pages said a native macOS run keeps PostgreSQL calls, and those of every service but HTTP/HTTPS, gRPC, MySQL and MongoDB, as raw bytes that usually don't replay. Keploy 3.9.4's macOS CLI also decodes PostgreSQL, Aerospike, Couchbase, Memcached, Apache HBase and Apache ZooKeeper calls, records them as mocks of their own protocol and replays them with the service stopped. Each macOS line now lists them. Redis, Kafka and Apache Pulsar calls are still captured as raw bytes on macOS, and the lines say so. The Windows lines are unchanged. Signed-off-by: slayerjain --- content/llms-full-root.txt | 4 ++-- versioned_docs/version-4.0.0/concepts/installation.md | 2 +- .../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/keploy-explained/dev-guide.md | 2 +- versioned_docs/version-4.0.0/server/installation.md | 2 +- versioned_docs/version-4.0.0/server/installation_tabs.md | 2 +- versioned_docs/version-4.0.0/server/macos/installation.md | 2 +- 8 files changed, 9 insertions(+), 9 deletions(-) diff --git a/content/llms-full-root.txt b/content/llms-full-root.txt index f91871293..4a69566cd 100644 --- a/content/llms-full-root.txt +++ b/content/llms-full-root.txt @@ -91,7 +91,7 @@ Key architectural components: - HTTP/HTTPS: External API call mocking - Redis: Command-level mocking -Natively on macOS and Windows, Keploy understands HTTP/HTTPS, MySQL and MongoDB calls, and on macOS gRPC calls too; calls to other services (PostgreSQL, Redis, Kafka, SQS, …, and gRPC on Windows) are captured only as raw bytes and usually don't replay. For those, run Keploy with Docker (or on Linux or WSL). +Natively on macOS and Windows, Keploy understands HTTP/HTTPS, MySQL and MongoDB calls, and on macOS gRPC, PostgreSQL, Aerospike, Couchbase, Memcached, Apache HBase and Apache ZooKeeper calls too; calls to other services (Redis, Kafka, Apache Pulsar, …, and PostgreSQL and gRPC on Windows) are captured only as raw bytes and usually don't replay. For those, run Keploy with Docker (or on Linux or WSL). --- @@ -114,7 +114,7 @@ On macOS, start the app itself rather than through a launcher (`npm start`, `mvn Runs natively on x86-64 Windows: install `keploy.exe` and run it from an ordinary PowerShell — no WSL, no Docker and no Administrator (https://keploy.io/docs/installation/windows-installation/#option-1-run-keploy-natively). On Windows on ARM, run Keploy inside WSL (https://keploy.io/docs/installation/windows-installation/). ### Docker -Keploy can run as a Docker container alongside your application using Docker Compose or standalone Docker commands. The Docker route works on Linux, Apple Silicon macOS and x86-64 Windows, and is the one to use on macOS or Windows when your app depends on services Keploy doesn't understand natively there (PostgreSQL, Redis, Kafka, gRPC on Windows, …). +Keploy can run as a Docker container alongside your application using Docker Compose or standalone Docker commands. The Docker route works on Linux, Apple Silicon macOS and x86-64 Windows, and is the one to use on macOS or Windows when your app depends on services Keploy doesn't understand natively there (Redis, Kafka, Apache Pulsar, …, and PostgreSQL and gRPC on Windows). ### Platform Requirements - Linux: Kernel 5.10 or later (eBPF) diff --git a/versioned_docs/version-4.0.0/concepts/installation.md b/versioned_docs/version-4.0.0/concepts/installation.md index 392f0fb86..9973249fc 100644 --- a/versioned_docs/version-4.0.0/concepts/installation.md +++ b/versioned_docs/version-4.0.0/concepts/installation.md @@ -81,7 +81,7 @@ On **Windows** (x86-64), Keploy is a single `keploy.exe`, installed from PowerSh **_Downloading and running Keploy in Docker_** -With this method your application and Keploy's agent run in Docker, but the `keploy` CLI — which starts them both — runs on your machine. Use it when your app runs in containers, or on macOS and Windows when your app depends on services beyond HTTP/HTTPS, MySQL and MongoDB (and gRPC, on macOS): natively there, calls to other services — PostgreSQL, Redis, Kafka, gRPC on Windows and the like — are captured only as raw bytes and usually don't replay. +With this method your application and Keploy's agent run in Docker, but the `keploy` CLI — which starts them both — runs on your machine. Use it when your app runs in containers, or on macOS and Windows when your app depends on services beyond HTTP/HTTPS, MySQL and MongoDB (and, on macOS, gRPC, PostgreSQL, Aerospike, Couchbase, Memcached, Apache HBase and Apache ZooKeeper): natively there, calls to other services — Redis, Kafka, Apache Pulsar and the like, and on Windows PostgreSQL and gRPC — are captured only as raw bytes and usually don't replay. 1. Open up a terminal window. 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 d5855479a..010cdfe0d 100644 --- a/versioned_docs/version-4.0.0/concepts/platform-requirements.md +++ b/versioned_docs/version-4.0.0/concepts/platform-requirements.md @@ -33,7 +33,7 @@ Linux: | Windows **Windows** | Supported Native, x86‑64 (Go, Node, Python, Java) | [Guide](/server/install/) | **Native: nothing to install** — no WSL, no Docker, no Administrator.
Only if you choose a container route: [WSL](https://learn.microsoft.com/en-us/windows/wsl/install#install-wsl-command) (`wsl --install`, Windows 10 2004+/build 19041+ or Windows 11 — also the route on Windows/ARM), or Docker Desktop 4.25.2+. | | Linux **Linux** | Supported | Supported | Linux kernel 5.10 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. Natively on macOS and Windows, Keploy understands HTTP/HTTPS, MySQL and MongoDB calls, and on macOS gRPC calls too; calls to other services — PostgreSQL, Redis, Kafka, gRPC on Windows and the like — are captured only as raw bytes and usually don't replay, so for an app that runs in containers or depends on them, use Docker. Docker, Lima (macOS) and WSL (Windows) remain supported alternatives, and WSL is the route on Windows on ARM. Keploy doesn't support Intel Macs: every macOS route, Docker and Lima included, runs the native CLI on the Mac, which is Apple Silicon only. +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. Natively on macOS and Windows, Keploy understands HTTP/HTTPS, MySQL and MongoDB calls, and on macOS gRPC, PostgreSQL, Aerospike, Couchbase, Memcached, Apache HBase and Apache ZooKeeper calls too; calls to other services — Redis, Kafka, Apache Pulsar and the like, and on Windows PostgreSQL and gRPC — are captured only as raw bytes and usually don't replay, so for an app that runs in containers or depends on them, use Docker. Docker, Lima (macOS) and WSL (Windows) remain supported alternatives, and WSL is the route on Windows on ARM. Keploy doesn't support Intel Macs: every macOS route, Docker and Lima included, runs the native CLI on the Mac, which is Apple Silicon only. Low-latency recording (`keploy record --low-latency`, or a Kubernetes Sidecar with `low_latency_mode`) and the Kubernetes DaemonSet agent capture with eBPF hooks that arm64 kernels support only from 6.4 (x86-64 kernels from 5.10). On an older arm64 kernel, record without low latency, and use Sidecar mode without `low_latency_mode` in Kubernetes. diff --git a/versioned_docs/version-4.0.0/installation/macos.md b/versioned_docs/version-4.0.0/installation/macos.md index 4f96f38b8..a7690ab77 100644 --- a/versioned_docs/version-4.0.0/installation/macos.md +++ b/versioned_docs/version-4.0.0/installation/macos.md @@ -16,7 +16,7 @@ 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 support covers **Go, Node.js, Python and Java** apps, including their HTTPS traffic, and understands their **HTTP/HTTPS, gRPC, MySQL and MongoDB** calls; calls to other services — PostgreSQL, Redis, Kafka and the like — are captured only as raw bytes and usually don't replay. If your app runs in containers, or depends on one of those other services, use [Docker](#option-3-install-keploy-with-docker). Keploy doesn't support Intel Macs. +Native macOS support covers **Go, Node.js, Python and Java** apps, including their HTTPS traffic, and understands their **HTTP/HTTPS, gRPC, PostgreSQL, MySQL, MongoDB, Aerospike, Couchbase, Memcached, Apache HBase and Apache ZooKeeper** calls; calls to other services — Redis, Kafka, Apache Pulsar and the like — are captured only as raw bytes and usually don't replay. If your app runs in containers, or depends on one of those other services, use [Docker](#option-3-install-keploy-with-docker). Keploy doesn't support Intel Macs. :::note Keploy needs a free account 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 65c5bb915..b28e5f1f1 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 @@ -197,7 +197,7 @@ source /dev/stdin <<<"$(curl -fsSL https://keploy.io/install.sh || echo 'echo Ke
:::info -Keploy runs natively on Apple Silicon Macs: no Lima VM, no Docker and no `sudo`. Natively it understands the HTTP/HTTPS, gRPC, MySQL and MongoDB calls of Go, Node.js, Python and Java apps; calls to other services — PostgreSQL, Redis, Kafka and the like — are captured only as raw bytes and usually don't replay — see [Installing Keploy on macOS](/docs/installation/macos-installation/). For containerized apps or those other dependencies use **Docker**. The macOS CLI is Apple Silicon (arm64) only: Keploy doesn't support Intel Macs. +Keploy runs natively on Apple Silicon Macs: no Lima VM, no Docker and no `sudo`. Natively it understands the HTTP/HTTPS, gRPC, PostgreSQL, MySQL, MongoDB, Aerospike, Couchbase, Memcached, Apache HBase and Apache ZooKeeper calls of Go, Node.js, Python and Java apps; calls to other services — Redis, Kafka, Apache Pulsar and the like — are captured only as raw bytes and usually don't replay — see [Installing Keploy on macOS](/docs/installation/macos-installation/). For containerized apps or those other dependencies use **Docker**. The macOS CLI is Apple Silicon (arm64) only: Keploy doesn't support Intel Macs. ::: diff --git a/versioned_docs/version-4.0.0/server/installation.md b/versioned_docs/version-4.0.0/server/installation.md index e081e7989..6abedeadd 100644 --- a/versioned_docs/version-4.0.0/server/installation.md +++ b/versioned_docs/version-4.0.0/server/installation.md @@ -65,7 +65,7 @@ Keploy records the API calls your app serves as test cases, and the calls your a It runs natively, with no VM and no Docker: - **Linux** (kernel 5.10 or later): Keploy intercepts calls with eBPF, which needs root. Run `keploy` as your own user; it asks for `sudo` itself when a command needs it. -- **macOS with Apple silicon**: in user space, with no `sudo`. Natively it understands the HTTP/HTTPS, gRPC, MySQL and MongoDB calls of Go, Node.js, Python and Java apps. Calls to other services, such as PostgreSQL, Redis or Kafka, are captured only as raw bytes and usually don't replay, so run an app that depends on them [with Docker](/docs/installation/macos-installation/#option-3-install-keploy-with-docker). +- **macOS with Apple silicon**: in user space, with no `sudo`. Natively it understands the HTTP/HTTPS, gRPC, PostgreSQL, MySQL, MongoDB, Aerospike, Couchbase, Memcached, Apache HBase and Apache ZooKeeper calls of Go, Node.js, Python and Java apps. Calls to other services, such as Redis, Kafka or Apache Pulsar, are captured only as raw bytes and usually don't replay, so run an app that depends on them [with Docker](/docs/installation/macos-installation/#option-3-install-keploy-with-docker). - **Windows** (x86-64): the same commands, with `keploy.exe` installed as [the Windows guide](/docs/installation/windows-installation/#option-1-run-keploy-natively) shows. **Keploy doesn't support Intel Macs.** On Windows on ARM, run Keploy in WSL. 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 071fe217f..ff6992967 100644 --- a/versioned_docs/version-4.0.0/server/installation_tabs.md +++ b/versioned_docs/version-4.0.0/server/installation_tabs.md @@ -277,7 +277,7 @@ If the rootful `podman.socket` is enabled (`sudo systemctl enable --now podman.s
:::info -Keploy runs **natively** on Apple Silicon Macs: no Lima VM, no Docker and no `sudo`. Natively it understands the **HTTP/HTTPS, gRPC, MySQL and MongoDB** calls of Go, Node.js, Python and Java apps; calls to other services — PostgreSQL, Redis, Kafka and the like — are captured only as raw bytes and usually don't replay. +Keploy runs **natively** on Apple Silicon Macs: no Lima VM, no Docker and no `sudo`. Natively it understands the **HTTP/HTTPS, gRPC, PostgreSQL, MySQL, MongoDB, Aerospike, Couchbase, Memcached, Apache HBase and Apache ZooKeeper** calls of Go, Node.js, Python and Java apps; calls to other services — Redis, Kafka, Apache Pulsar and the like — are captured only as raw bytes and usually don't replay. - Your app runs in containers, or depends on one of those other services? Use the **Docker** tab. - The `keploy` CLI for macOS is Apple Silicon (arm64) only, and the Docker tab uses it too. Keploy doesn't support Intel Macs. 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 1dcd41b2e..3321a9544 100644 --- a/versioned_docs/version-4.0.0/server/macos/installation.md +++ b/versioned_docs/version-4.0.0/server/macos/installation.md @@ -53,7 +53,7 @@ There are two ways to install Keploy on macOS: 1. **Recommended:** [One-click install](#one-click-install-keploy). 2. [Install with Homebrew](#install-with-homebrew). -Natively on macOS, Keploy understands HTTP/HTTPS, gRPC, MySQL and MongoDB calls; calls to other services — PostgreSQL, Redis, Kafka and the like — are captured only as raw bytes and usually don't replay. If your app runs in containers or depends on one of those other services, a [manual setup with Docker Desktop or Colima](#manual-setup) is also available. +Natively on macOS, Keploy understands HTTP/HTTPS, gRPC, PostgreSQL, MySQL, MongoDB, Aerospike, Couchbase, Memcached, Apache HBase and Apache ZooKeeper calls; calls to other services — Redis, Kafka, Apache Pulsar and the like — are captured only as raw bytes and usually don't replay. If your app runs in containers or depends on one of those other services, a [manual setup with Docker Desktop or Colima](#manual-setup) is also available. :::note Apple Silicon only