Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions vale_styles/config/vocabularies/Base/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ JaCoCo
JBehave
Jersey
JMeter
KMocks
KTests
json_contains
json_equal
json_path
Expand Down
76 changes: 60 additions & 16 deletions versioned_docs/version-4.0.0/server/macos/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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';

<HowTo
name="Install Keploy on macOS"
description="Install the Keploy CLI on macOS using the one-click curl installer."
totalTime="PT5M"
estimatedCost={{currency: "USD", value: "0"}}
tools={["bash", "curl"]}
supplies={["A macOS machine"]}
visible={false}
steps={[
{
name: "One-click install",
text: "Run: curl --silent -O -L https://keploy.io/install.sh && source install.sh",
url: "#one-click-install-keploy",
},
/* 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.
{
name: "Install with Homebrew",
text: "Run: brew install keploy/tap/keploy",
url: "#install-with-homebrew",
},
*/
]}
/>

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).
<!--
## Install with Homebrew

## One click install Keploy.
_Homebrew installation is temporarily disabled while we resolve known issues with the `keploy/tap` formula. Once fixed, this section will be restored._

If you prefer [Homebrew](https://brew.sh/), install Keploy from the official Keploy tap:

```shell
curl --silent -O -L https://keploy.io/install.sh && source install.sh
brew install keploy/tap/keploy
```

## Using Docker Desktop
Verify the install:

```shell
keploy --version
```
-->

## 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.
Comment thread
gouravkrosx marked this conversation as resolved.
Comment thread
gouravkrosx marked this conversation as resolved.

### Creating Docker Volume & Network
#### Creating Docker Volume & Network

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

Expand All @@ -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:

Expand All @@ -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.
Expand All @@ -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!

Expand All @@ -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.

Expand Down
Loading