Skip to content

Commit ce5324c

Browse files
Achanandhi-MAchanandhi-M
committed
fix: installation and template
Signed-off-by: Achanandhi-M <[email protected]>
1 parent 4bfad0a commit ce5324c

File tree

7 files changed

+299
-199
lines changed

7 files changed

+299
-199
lines changed

‎src/components/QuickStart.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ export const QuickStart = () => {
6565
<div className="grid grid-cols-1 gap-6 md:grid-cols-3 lg:gap-8">
6666
<Link
6767
className="scale flex flex-col items-center justify-center space-y-3 rounded-lg bg-[color:var(--ifm-card-background-color)] p-6 text-center shadow-lg"
68-
to={useBaseUrl("/server/installation/")}
68+
to={useBaseUrl("/installation/windows-installation/")}
6969
>
7070
<img
7171
className="h-16 w-16"
@@ -76,7 +76,7 @@ export const QuickStart = () => {
7676
</Link>
7777
<Link
7878
className="scale flex flex-col items-center justify-center space-y-3 rounded-lg bg-[color:var(--ifm-card-background-color)] p-6 text-center shadow-lg"
79-
to={useBaseUrl("/server/installation/")}
79+
to={useBaseUrl("/installation/linux-installation/")}
8080
>
8181
<img
8282
className="h-16 w-16"
@@ -87,7 +87,7 @@ export const QuickStart = () => {
8787
</Link>
8888
<Link
8989
className="scale flex flex-col items-center justify-center space-y-3 rounded-lg bg-[color:var(--ifm-card-background-color)] p-6 text-center shadow-lg"
90-
to={useBaseUrl("/server/installation/")}
90+
to={useBaseUrl("/installation/macos-installation/")}
9191
>
9292
<img
9393
className="h-16 w-16"

‎versioned_docs/version-2.0.0/server/installation.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,4 @@ To run the testcases and see if there are any regressions introduced, use this t
4949
keploy test -c "CMD_TO_RUN_APP" --delay 10
5050
```
5151

52-
Explore the [Test Coverage Generation Guide](https://keploy.io/docs/server/sdk-installation/go/) for seeing test-coverage with your unit testing library and [Keploy Running Guide](https://keploy.io/docs/running-keploy/configuration-file/) for additional options and tips on customizing your Keploy setup to perfection.
52+
Explore the [Test Coverage Generation Guide](https://keploy.io/docs/server/sdk-installation/go/) for seeing test-coverage with your unit testing library and [Keploy Running Guide](https://keploy.io/docs/running-keploy/configuration-file/) for additional options and tips on customizing your Keploy setup to perfection.

‎versioned_docs/version-3.0.0/installation/linux.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
id: linux-installation
3+
title: Installing Keploy on Linux
4+
sidebar_label: Linux Installation
5+
description: A quick guide to installing Keploy on Linux.
6+
tags:
7+
- installation
8+
keywords:
9+
- linux
10+
- installation
11+
---
12+
13+
# Installing Keploy on Linux
14+
15+
Keploy uses eBPF to intercept API calls on network layer and generates test cases and mocks/stubs. Installing Keploy on Linux is super easy it works on **any Linux distribution** with a simple one-click installation 🚀
16+
17+
## 1. Install Keploy
18+
19+
Run the following command in your terminal:
20+
21+
```bash
22+
curl --silent -O -L https://keploy.io/install.sh && source install.sh
23+
````
24+
25+
## 2. Verify Installation
26+
27+
After installation, check if Keploy is working by running:
28+
29+
```bash
30+
keploy version
31+
```
32+
33+
✅ If you see the version number, Keploy has been installed successfully!
34+
35+
## 🎉 Congratulations!
36+
37+
You’ve successfully installed **Keploy on Linux**.
38+
39+
## What's Next?
40+
41+
### 🎬 [Start Capturing Test Cases](/docs/server/installation/#-capturing-testcases)
42+
43+
Begin recording your API calls and automatically generate test cases with Keploy.

‎versioned_docs/version-3.0.0/installation/macos.md‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
---
2+
id: macos-installation
3+
title: Installing Keploy on macOS
4+
sidebar_label: macOS Installation
5+
description: A guide to installing Keploy on macOS using Lima or Docker.
6+
tags:
7+
- installation
8+
keywords:
9+
- macos
10+
- installation
11+
- docker
12+
- ebpf
13+
- lima
14+
---
15+
16+
# Installing Keploy on macOS
17+
18+
Keploy uses eBPF to intercept API calls on network layer and generates test cases and mocks/stubs. Keploy does not natively support macOS. However, you can still run it using **Lima** or **Docker**.
19+
20+
👉 **Choose your preferred method:**
21+
22+
- [Option 1: Install Keploy with Lima](#option-1-install-keploy-with-lima)
23+
24+
- [Option 2: Install Keploy with Docker](#option-2-install-keploy-with-docker)
25+
26+
27+
## Option 1: Install Keploy with Lima
28+
29+
1. **Check if Lima is installed**
30+
If you already have Lima, Go to Step 6.
31+
32+
2. **Install Lima**
33+
34+
```bash
35+
brew install lima
36+
````
37+
38+
3. **Create a Debian instance**
39+
40+
```bash
41+
limactl create template://debian-12
42+
```
43+
44+
4. **Start the instance**
45+
46+
```bash
47+
limactl start debian-12
48+
```
49+
50+
5. **Enter the Linux shell**
51+
52+
```bash
53+
limactl shell debian-12
54+
```
55+
56+
6. **Install Keploy inside Lima**
57+
58+
```bash
59+
curl --silent -O -L https://keploy.io/install.sh && source install.sh
60+
```
61+
62+
7. **Verify the installation**
63+
64+
```bash
65+
keploy version
66+
```
67+
68+
✅ If the version shows up, Keploy is installed successfully!
69+
70+
## What's Next?
71+
72+
### 🎬 [Start Capturing Test Cases](/docs/server/installation/#-capturing-testcases)
73+
74+
Begin recording your API calls and automatically generate test cases with Keploy.
75+
76+
---
77+
78+
## Option 2: Install Keploy with Docker
79+
80+
1. **Make sure Docker is installed**
81+
You’ll need Docker Desktop running on macOS.
82+
83+
2. **Create a Docker bridge network**
84+
85+
```bash
86+
docker network create keploy-network
87+
```
88+
89+
3. **Install Keploy**
90+
91+
```bash
92+
curl --silent -O -L https://keploy.io/install.sh && source install.sh
93+
```
94+
4. **Verify the installation**
95+
96+
```bash
97+
keploy version
98+
```
99+
100+
✅ If the version shows up, Keploy is installed successfully!
101+
102+
103+
## What's Next?
104+
105+
🎬 Start Capturing Test cases
106+
107+
### ▶️ Record
108+
109+
```bash
110+
keploy record -c "docker run -p 8080:8080 --name <containerName> --network keploy-network <applicationImage>" \
111+
--container-name "<containerName>" --buildDelay 60
112+
```
113+
114+
### 🧪 Test
115+
116+
```bash
117+
keploy test -c "docker run -p 8080:8080 --name <containerName> --network keploy-network <applicationImage>" \
118+
--delay 10 --buildDelay 60
119+
```
120+
121+
## 🎉 Congratulations!
122+
123+
You’ve successfully set up **Keploy on macOS** using either **Lima** or **Docker**.

‎versioned_docs/version-3.0.0/installation/windows.md‎

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
---
2+
id: windows-installation
3+
title: Running Keploy on Windows
4+
sidebar_label: Windows Installation
5+
tags:
6+
- windows
7+
- ebpf
8+
- windows installation
9+
- installation
10+
- installation-guide
11+
keywords:
12+
- windows
13+
- ebpf
14+
- installation
15+
---
16+
17+
# Installing Keploy on Windows
18+
19+
Keploy uses eBPF to intercept API calls on network layer and generates test cases and mocks/stubs. Keploy does not natively support Windows. However, you can still run it using **Wsl** or **Docker**.
20+
21+
👉 **Choose your preferred method:**
22+
23+
- [Option 1: Install Keploy with WSL](#option-1-install-keploy-with-wsl)
24+
25+
- [Option 2: Install Keploy with Docker](#option-2-install-keploy-with-docker)
26+
27+
28+
## Option 1: Install Keploy with WSL
29+
30+
If you already have WSL, Go to Step 2.
31+
32+
1. **Enable WSL**
33+
34+
Make sure you’re on:
35+
- **Windows 10** (version 2004 or later, build 19041+)
36+
- **Windows 11**
37+
38+
Run the following command in PowerShell (as Administrator):
39+
40+
```shell
41+
wsl --install -d <Distribution Name>
42+
````
43+
44+
👉 We recommend using **Ubuntu-22.04** for the best experience.
45+
(You can choose a different distribution if needed.)
46+
47+
48+
2. **Install Keploy Binary**
49+
Inside your WSL terminal, run:
50+
51+
```shell
52+
curl --silent -O -L https://keploy.io/install.sh && source install.sh
53+
```
54+
55+
3. **Verify Installation**
56+
57+
```bash
58+
keploy version
59+
```
60+
61+
✅ If you see the version number, Keploy is installed successfully!
62+
63+
## What's Next?
64+
65+
### 🎬 [Start Capturing Test Cases](/docs/server/installation/#-capturing-testcases)
66+
67+
Begin recording your API calls and automatically generate test cases with Keploy.
68+
69+
---
70+
71+
72+
## Option 2: Install Keploy with Docker
73+
74+
1. **Make sure Docker is installed**
75+
You’ll need **Docker Desktop** running on Windows.
76+
77+
2. **Create a Docker bridge network**
78+
79+
```bash
80+
docker network create keploy-network
81+
```
82+
83+
3. **Install Keploy**
84+
85+
```bash
86+
curl --silent -O -L https://keploy.io/install.sh && source install.sh
87+
```
88+
89+
4. **Verify the installation**
90+
91+
```bash
92+
keploy version
93+
```
94+
95+
✅ If the version shows up, Keploy is installed successfully!
96+
97+
98+
## What's Next?
99+
100+
🎬 Start Capturing Test cases
101+
102+
### ▶️ Record
103+
104+
```bash
105+
keploy record -c "docker run -p 8080:8080 --name <containerName> --network keploy-network <applicationImage>" \
106+
--container-name "<containerName>" --buildDelay 60
107+
```
108+
109+
### 🧪 Test
110+
111+
```bash
112+
keploy test -c "docker run -p 8080:8080 --name <containerName> --network keploy-network <applicationImage>" \
113+
--delay 10 --buildDelay 60
114+
```
115+
116+
117+
## 🎉 Congratulations!
118+
119+
You’ve successfully set up **Keploy on Windows** using either **WSL** or **Docker**.

0 commit comments

Comments
 (0)