docs(macos): Apple Silicon only, and stop saying Keploy cannot run natively on macOS - #911
Merged
Merged
Conversation
…l 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 <shubham@keploy.io>
… build can "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 <shubham@keploy.io>
Signed-off-by: slayerjain <shubham@keploy.io>
slayerjain
force-pushed
the
chore/macos-arm64-only
branch
from
September 22, 2026 09:04
4d6eb58 to
8783bb6
Compare
…tioned 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 <shubham@keploy.io>
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 <shubham@keploy.io>
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 <shubham@keploy.io>
This was referenced Sep 22, 2026
slayerjain
added a commit
that referenced
this pull request
Sep 22, 2026
#911 made every user-facing page describe one binary, keploy, with no edition vocabulary. Four engineering pages still said "the OSS replayer" and "the OSS `config.Record` struct", and the k8s-proxy LLM workflow called `keploy record` "the local OSS command". They are describing the replayer package (the import path is unchanged and still names it) rather than telling a reader which build to install, which is why they survived the first pass — but the convention is that the docs do not make the reader sort out editions anywhere. Signed-off-by: slayerjain <shubham@keploy.io>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Documents that Keploy's native macOS CLI is Apple Silicon (arm64) only, routes Intel Macs to Lima, and fixes the pages that still said Keploy cannot run natively on macOS or Windows.
Companion to keploy/keploy#4627 and keploy/enterprise#2639, which drop the darwin/amd64 build. macOS 27 ends support for Intel Macs; Intel hardware is frozen on older releases, where Lima or Docker remains the way to run Keploy.
Pages
installation/macos.md— an admonition under Option 1, and one under Option 3, because Docker is not an Intel escape hatch: your app and the agent run in containers, but thekeployCLI driving them is the native build on the host. Lima is the Intel route, since it installs the Linux build inside the VM.concepts/platform-requirements.md— macOS row and the summary paragraph.concepts/installation.md— two "not supported natively on macOS" notes that were stale rewritten to what is true.running-keploy/mock-your-tests.mdandmock-quickstart.md— listed macOS as container-only and told Windows users to open an Administrator shell. Native record works on macOS and 64-bit Windows, and userspace interception needs neither Administrator norsudo.keploy-explained/mac-linux.mdandwindows-wsl.md— titled "native" but describe a Lima VM and WSL; both now point at the real native route first and keep the VM route for what it is for (an Intel Mac, Windows/ARM).keploy-explained/dev-guide.md(Contribution Guide) — its macOS tab claimed native recording for the open-source build, which intercepts with eBPF; corrected.server/macos/installation.md,server/installation_tabs.md,content/llms-full-root.txt.Wording
The docs describe one binary, keploy, and do not ask the reader to sort out editions. Native macOS/Windows is simply what Keploy does; nothing here says "OSS" or "Community Edition". The Windows page's pre-existing warning about the
keploy_windows_amd64GitHub release asset keeps its point (that build refuses a native Windows run) without the edition vocabulary.versioned_docs/version-1.0.0is left alone: it pins v0.9.1, a release that really does publishkeploy_darwin_all.tar.gz.