From 4c9b899dc6f72095e88e8dc92f9785448c0f6e79 Mon Sep 17 00:00:00 2001 From: gouravkrosx Date: Fri, 29 May 2026 08:45:53 +0000 Subject: [PATCH 1/2] docs(macos-install): drop brew install as primary; one-click curl is the only step Google's HowTo rich result for "install keploy macOS" was surfacing `brew install keploy` as step 1 (likely pulled from external Homebrew indexes), pushing the canonical curl one-liner to step 2. - Reduce the page's HowTo JSON-LD to a single step: the curl one-click install. - Comment out (don't delete) the "Install with Homebrew" section and its HowTo step so it can be restored once the keploy/tap formula issues are resolved. - Promote Docker Desktop + Colima to a single `## Manual Setup` section with sub-headings, since they're eBPF-environment setup, not a competing install method. - Strip `homebrew` / `brew install keploy` from frontmatter keywords and the page description so we stop signaling brew as an install path. Co-Authored-By: Claude Opus 4.7 (1M context) Signed-off-by: gouravkrosx --- .../server/macos/installation.md | 76 +++++++++++++++---- 1 file changed, 60 insertions(+), 16 deletions(-) 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 8a7f1ae6d..0d9015525 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 the Keploy server on macOS using Colima or Docker Desktop — one-click and manual setup options for eBPF testing." +description: "Install Keploy on macOS with the one-click curl installer. Docker Desktop and Colima setups are also supported for eBPF testing." tags: - hello-world - macos @@ -22,26 +22,70 @@ keywords: - docker --- -As of now there are two ways to use Keploy eBPF in MacOS, i.e. [using Colima](#using-colima) -and [using Docker Desktop](#using-docker-desktop). +import HowTo from '@site/src/components/HowTo'; + + + +The recommended way to install Keploy on macOS is the **one-click curl installer**. For users who need eBPF support, a [manual setup with Docker Desktop or Colima](#manual-setup) is also available. + +## One-click install Keploy + +Run the following command in your terminal: -There are two ways to install Keploy eBPF in MacOS, you can use either use: +```shell + curl --silent -O -L https://keploy.io/install.sh && source install.sh +``` -1. [One-Click Install](#one-click-install-keploy). -2. [Manual Setup](#using-docker-desktop). + + +## Manual Setup + +For eBPF support on macOS, you can run Keploy through either **Docker Desktop** or **Colima**. + +### Using Docker Desktop -Note: To run Keploy on MacOS through [Docker](https://docs.docker.com/desktop/release-notes/#4252) the version must +Note: To run Keploy on macOS through [Docker](https://docs.docker.com/desktop/release-notes/#4252) the version must be `4.25.2` or above. -### Creating Docker Volume & Network +#### Creating Docker Volume & Network We need to create debug volume to run Keploy using Docker-Desktop: @@ -59,9 +103,9 @@ below. docker network create keploy-network ``` -## Using Colima +### Using Colima -### Install Colima +#### Install Colima You need to have the latest version of `brew` installed on your system and then run this command from a terminal: @@ -75,7 +119,7 @@ Start Colima with defaults colima start ``` -### Creating Alias +#### Creating Alias We need to create a custom network for Keploy since we are using the Docker, therefore application container would require `docker network` to act as the bridge between them. @@ -87,7 +131,7 @@ below. docker network create keploy-network ``` -### Recording Testcases and Data Mocks +#### Recording Testcases and Data Mocks Here are few points to consider before recording! @@ -110,7 +154,7 @@ Make API Calls using Postman, or cURL commands. Keploy will capture the API calls you've conducted, generating test suites comprising **testcases (KTests) and data mocks (KMocks)** in `YAML` format. -### Running Testcases +#### Running Testcases Now, execute the testcases. Follow these steps in the **root directory** of your application. From 03fc82d52ab6f288a09e7cb7c54033f403de5f2c Mon Sep 17 00:00:00 2001 From: gouravkrosx Date: Fri, 29 May 2026 09:07:53 +0000 Subject: [PATCH 2/2] chore(vale): accept KTests and KMocks as Keploy terms Vale flagged "KTests" and "KMocks" as misspellings in the macOS install doc (and the v2/v3 archived versions of the same page). They are Keploy-specific proper nouns for recorded test cases and mocks, used intentionally in the prose. Add them to the Base accept vocabulary so docs touching these files stop tripping vale-doc-linter. Co-Authored-By: Claude Opus 4.7 (1M context) Signed-off-by: gouravkrosx --- vale_styles/config/vocabularies/Base/accept.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/vale_styles/config/vocabularies/Base/accept.txt b/vale_styles/config/vocabularies/Base/accept.txt index f19f1c95a..1b5c9d8aa 100644 --- a/vale_styles/config/vocabularies/Base/accept.txt +++ b/vale_styles/config/vocabularies/Base/accept.txt @@ -99,6 +99,8 @@ JaCoCo JBehave Jersey JMeter +KMocks +KTests json_contains json_equal json_path