Skip to content
Open
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
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -203,4 +203,7 @@ Temporary Items

# Support for Project snippet scope

# End of https://www.toptal.com/developers/gitignore/api/macos,linux,jetbrains,visualstudiocode
# End of https://www.toptal.com/developers/gitignore/api/macos,linux,jetbrains,visualstudiocode
.claude/qa-agent/

.claude/commands/
13 changes: 9 additions & 4 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,12 @@ module.exports = {
{property: "og:image:height", content: "630"},
],
headTags: [
{
tagName: "script",
attributes: {},
innerHTML:
"window.dataLayer=window.dataLayer||[];window.gtag=window.gtag||function(){window.dataLayer.push(arguments);};",
},
// Google Fonts - DM Sans (loaded via headTags instead of CSS @import)
{
tagName: "link",
Expand Down Expand Up @@ -438,11 +444,10 @@ module.exports = {
theme: {
customCss: require.resolve("./src/css/custom.css"),
},
gtag: {
gtag: process.env.NODE_ENV === "production" ? {
trackingID: "G-LLS95VWZPC",
// Optional fields.
anonymizeIP: true, // Should IPs be anonymized?
},
anonymizeIP: true,
} : false,
// Will be passed to @docusaurus/plugin-content-sitemap
sitemap: {
// Per v2.0.0-alpha.72 cacheTime is now deprecated
Expand Down
199 changes: 198 additions & 1 deletion versioned_docs/version-4.0.0/keploy-explained/dev-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ tags:
- contribution guide
---

# Contribution Guide 🚀
# Contribution Guide

Welcome to the world of Keploy development! This guide will help you set up Keploy locally.

Expand Down Expand Up @@ -113,3 +113,200 @@ Happy testing! 🧪🔍💻
> **Note** :- Run `go run github.com/99designs/gqlgen generate --config pkg/graph/gqlgen.yml` to generate the graphql server stubs which can be used when working with unit testing libraries like JUnit, PyTest, etc..

Hope this helps you out, if you still have any questions, reach out to us on [slack](https://keploy.slack.com/join/shared_invite/zt-357qqm9b5-PbZRVu3Yt2rJIa6ofrwWNg) .

## Installing the Open Source Build

To install the open-source version of Keploy, use the `--oss` flag:

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import StartKeploy from '@site/src/components/StartKeploy';
import StartKeployDocker from '@site/src/components/StartKeployDocker';
Comment on lines +121 to +124
Copy link

Copilot AI Apr 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new OSS install section adds MDX import ... statements after existing Markdown content. In Docusaurus/MDX, ESM imports must be at the top level before any rendered content; otherwise the file can fail to compile. Move these imports to the top of the document (right after the frontmatter) or refactor the section to avoid late imports.

Copilot uses AI. Check for mistakes.

<Tabs>
<TabItem value="linux" label="Linux">
<br />

:::info
Make sure your Linux kernel version is **5.10 or higher**.
:::

👉 **Choose your preferred method:**

<Tabs>
<TabItem value="linux-native" label="Native">

### 1. Install Keploy

```bash
curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss
```

### 2. Once done, you should see something like this:

```bash
▓██▓▄
▓▓▓▓██▓█▓▄
████████▓▒
▀▓▓███▄ ▄▄ ▄ ▌
▄▌▌▓▓████▄ ██ ▓█▀ ▄▌▀▄ ▓▓▌▄ ▓█ ▄▌▓▓▌▄ ▌▌ ▓
▓█████████▌▓▓ ██▓█▄ ▓█▄▓▓ ▐█▌ ██ ▓█ █▌ ██ █▌ █▓
▓▓▓▓▀▀▀▀▓▓▓▓▓▓▌ ██ █▓ ▓▌▄▄ ▐█▓▄▓█▀ █▓█ ▀█▄▄█▀ █▓█
▓▌ ▐█▌ █▌

OPEN SOURCE

Available Commands:
example Example to record and test via keploy
config --generate generate the keploy configuration file
record record the keploy testcases from the API calls
test run the recorded testcases and execute assertions
update Update Keploy

Flags:
--debug Run in debug mode
-h, --help help for keploy
-v, --version version for keploy

Use "keploy [command] --help" for more information about a command.
```

🎉 You have successfully installed **Keploy OSS on Linux**.

<StartKeploy />
</TabItem>

<TabItem value="docker-linux" label="Docker">

### Install Keploy OSS with Docker on Linux

1. Make sure Docker is installed on Linux.
2. Install Keploy

```bash
curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss
```

🎉 You have successfully set up **Keploy OSS on Linux** using **Docker**.

<StartKeployDocker />
</TabItem>
</Tabs>
</TabItem>

<TabItem value="macos" label="macOS">
<br />

:::info
Keploy does not natively support macOS. You can run it using **Lima** or **Docker**.
:::

<Tabs>
<TabItem value="lima" label="Lima">

### Install Keploy OSS with Lima

1. Check if Lima is installed. If yes, skip to step 6.
2. Install Lima

```bash
brew install lima
```

3. Create a Debian instance

```bash
limactl create template://debian-12
```

4. Start the instance

```bash
limactl start debian-12
```

5. Enter the Linux shell

```bash
limactl shell debian-12
```

6. Install Keploy inside Lima

```bash
curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss
```

🎉 You have successfully set up **Keploy OSS on macOS** using **Lima**.

<StartKeploy />
</TabItem>

<TabItem value="docker-mac" label="Docker">

### Install Keploy OSS with Docker on macOS

1. Make sure Docker Desktop is running on macOS.
2. Install Keploy

```bash
curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss
```

🎉 You have successfully set up **Keploy OSS on macOS** using **Docker**.

<StartKeployDocker />
</TabItem>
</Tabs>
</TabItem>

<TabItem value="windows" label="Windows">
<br />

:::info
You can run Keploy using **WSL** or **Docker** on Windows.
:::

<Tabs>
<TabItem value="wsl" label="WSL">

### Install Keploy OSS with WSL

1. Enable WSL

```shell
wsl --install -d <Distribution Name>
```

👉 We recommend **Ubuntu-22.04**.

2. Install Keploy inside WSL

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

🎉 You have successfully set up **Keploy OSS on Windows** using **WSL**.

<StartKeploy />
</TabItem>

<TabItem value="docker-windows" label="Docker">

### Install Keploy OSS with Docker on Windows

1. Make sure Docker Desktop is running on Windows.
2. Install Keploy

```bash
curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss
```

🎉 You have successfully set up **Keploy OSS on Windows** using **Docker**.

<StartKeployDocker />
</TabItem>
</Tabs>
</TabItem>
</Tabs>
Loading
Loading