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 f862effb9..e5729dc0c 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, 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 | +| Operating System | Without Docker | Docker Installation | Prerequisites | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| macOS **macOS** | Supported Native, Apple Silicon (Go, Node, Python, Java) | [Guide](/server/install/) | **Native: nothing to install** — no Docker, no Lima, no `sudo`.
Only if you choose a container route: Docker Desktop 4.25.2+, or Lima (which is also the route on an Intel Mac). | +| 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.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. diff --git a/versioned_docs/version-4.0.0/server/installation.md b/versioned_docs/version-4.0.0/server/installation.md index 3f4612046..af4bec6f8 100644 --- a/versioned_docs/version-4.0.0/server/installation.md +++ b/versioned_docs/version-4.0.0/server/installation.md @@ -3,7 +3,7 @@ id: install title: Keploy Local Installation sidebar_label: Local hide_title: true -description: "Install Keploy locally on Linux using eBPF — record API calls, generate test cases, and replay tests with one command. By default, this installs the Keploy Community Edition." +description: "Install Keploy locally with one command — natively on Linux, macOS (Apple Silicon) and Windows. Record API calls, generate test cases, and replay them as tests." tags: - hello-world - linux @@ -26,18 +26,25 @@ keywords: - community edition --- -Keploy uses eBPF to intercept API calls on network layer and generates test cases and mocks/stubs. By default, the one-click install command below installs the **Keploy Community Edition**. Your plan (Community, Pro, or Enterprise) is determined after you log in. +Keploy intercepts your application's API calls and turns them into test cases and mocks. The one command below installs it on **Linux, macOS and Windows** alike — how it intercepts differs, but what you run does not: + +- **Linux** — eBPF in the kernel, so `keploy record`/`keploy test` need root. +- **macOS** (Apple Silicon) and **Windows** (x86‑64) — userspace interception. No VM, no Docker, no `sudo` and no Administrator. + +Docker, Lima and WSL remain supported alternatives, and are the route on an Intel Mac or Windows/ARM — but on a supported machine you do not need any of them. + +By default this installs the **Keploy Community Edition**. Your plan (Community, Pro, or Enterprise) is determined after you log in. import HowTo from '@site/src/components/HowTo'; import InstallationGuide from '../concepts/installation.md' = 5.10"]} -supplies={["A Linux or WSL2 machine", "Sudo access"]} +tools={["A terminal", "curl"]} +supplies={["Linux (kernel >= 5.10, with sudo), macOS on Apple Silicon, or Windows on x86-64"]} visible={false} steps={[ { @@ -89,6 +96,7 @@ Explore the [Test Coverage Generation Guide](https://keploy.io/docs/server/sdk-i ## Related -- [Installing Keploy](/docs/server/installation/) — the full install guide with OS tabs. +- [Installing Keploy on macOS](/docs/installation/macos-installation/) — native on Apple Silicon, or Lima/Docker. +- [Installing Keploy on Windows](/docs/installation/windows-installation/) — native on x86-64, or WSL/Docker. - [Keploy Go SDK — Install & Merge Test Coverage](/docs/server/sdk-installation/go/) — set up a language SDK. - [Keploy CLI Commands](/docs/running-keploy/cli-commands/) — commands to run after installing.