Skip to content

Commit cbd38c0

Browse files
gouravkrosxclaude
andauthored
docs(macos-install): drop brew install as primary; one-click curl is the only step (#867)
* 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) <noreply@anthropic.com> Signed-off-by: gouravkrosx <gouravgreatkr@gmail.com> * 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) <noreply@anthropic.com> Signed-off-by: gouravkrosx <gouravgreatkr@gmail.com> --------- Signed-off-by: gouravkrosx <gouravgreatkr@gmail.com> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent c6e9614 commit cbd38c0

2 files changed

Lines changed: 62 additions & 16 deletions

File tree

vale_styles/config/vocabularies/Base/accept.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,8 @@ JaCoCo
9999
JBehave
100100
Jersey
101101
JMeter
102+
KMocks
103+
KTests
102104
json_contains
103105
json_equal
104106
json_path

versioned_docs/version-4.0.0/server/macos/installation.md

Lines changed: 60 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
id: installation
33
title: macOS Installation
44
sidebar_label: macOS
5-
description: "Install the Keploy server on macOS using Colima or Docker Desktop — one-click and manual setup options for eBPF testing."
5+
description: "Install Keploy on macOS with the one-click curl installer. Docker Desktop and Colima setups are also supported for eBPF testing."
66
tags:
77
- hello-world
88
- macos
@@ -22,26 +22,70 @@ keywords:
2222
- docker
2323
---
2424

25-
As of now there are two ways to use Keploy eBPF in MacOS, i.e. [using Colima](#using-colima)
26-
and [using Docker Desktop](#using-docker-desktop).
25+
import HowTo from '@site/src/components/HowTo';
26+
27+
<HowTo
28+
name="Install Keploy on macOS"
29+
description="Install the Keploy CLI on macOS using the one-click curl installer."
30+
totalTime="PT5M"
31+
estimatedCost={{currency: "USD", value: "0"}}
32+
tools={["bash", "curl"]}
33+
supplies={["A macOS machine"]}
34+
visible={false}
35+
steps={[
36+
{
37+
name: "One-click install",
38+
text: "Run: curl --silent -O -L https://keploy.io/install.sh && source install.sh",
39+
url: "#one-click-install-keploy",
40+
},
41+
/* Homebrew install temporarily disabled — the keploy/tap formula has known issues being resolved. Re-enable this step (and the "Install with Homebrew" section below) once the tap is fixed.
42+
{
43+
name: "Install with Homebrew",
44+
text: "Run: brew install keploy/tap/keploy",
45+
url: "#install-with-homebrew",
46+
},
47+
*/
48+
]}
49+
/>
50+
51+
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.
52+
53+
## One-click install Keploy
54+
55+
Run the following command in your terminal:
2756

28-
There are two ways to install Keploy eBPF in MacOS, you can use either use:
57+
```shell
58+
curl --silent -O -L https://keploy.io/install.sh && source install.sh
59+
```
2960

30-
1. [One-Click Install](#one-click-install-keploy).
31-
2. [Manual Setup](#using-docker-desktop).
61+
<!--
62+
## Install with Homebrew
3263
33-
## One click install Keploy.
64+
_Homebrew installation is temporarily disabled while we resolve known issues with the `keploy/tap` formula. Once fixed, this section will be restored._
65+
66+
If you prefer [Homebrew](https://brew.sh/), install Keploy from the official Keploy tap:
3467
3568
```shell
36-
curl --silent -O -L https://keploy.io/install.sh && source install.sh
69+
brew install keploy/tap/keploy
3770
```
3871
39-
## Using Docker Desktop
72+
Verify the install:
73+
74+
```shell
75+
keploy --version
76+
```
77+
-->
78+
79+
## Manual Setup
80+
81+
For eBPF support on macOS, you can run Keploy through either **Docker Desktop** or **Colima**.
82+
83+
### Using Docker Desktop
4084

41-
Note: To run Keploy on MacOS through [Docker](https://docs.docker.com/desktop/release-notes/#4252) the version must
85+
Note: To run Keploy on macOS through [Docker](https://docs.docker.com/desktop/release-notes/#4252) the version must
4286
be `4.25.2` or above.
4387

44-
### Creating Docker Volume & Network
88+
#### Creating Docker Volume & Network
4589

4690
We need to create debug volume to run Keploy using Docker-Desktop:
4791

@@ -59,9 +103,9 @@ below.
59103
docker network create keploy-network
60104
```
61105

62-
## Using Colima
106+
### Using Colima
63107

64-
### Install Colima
108+
#### Install Colima
65109

66110
You need to have the latest version of `brew` installed on your system and then run this command from a terminal:
67111

@@ -75,7 +119,7 @@ Start Colima with defaults
75119
colima start
76120
```
77121

78-
### Creating Alias
122+
#### Creating Alias
79123

80124
We need to create a custom network for Keploy since we are using the Docker, therefore application container would
81125
require `docker network` to act as the bridge between them.
@@ -87,7 +131,7 @@ below.
87131
docker network create keploy-network
88132
```
89133

90-
### Recording Testcases and Data Mocks
134+
#### Recording Testcases and Data Mocks
91135

92136
Here are few points to consider before recording!
93137

@@ -110,7 +154,7 @@ Make API Calls using Postman, or cURL commands.
110154
Keploy will capture the API calls you've conducted, generating test suites comprising **testcases (KTests) and data
111155
mocks (KMocks)** in `YAML` format.
112156

113-
### Running Testcases
157+
#### Running Testcases
114158

115159
Now, execute the testcases. Follow these steps in the **root directory** of your application.
116160

0 commit comments

Comments
 (0)