Merge branch 'main' into fix/3649-broken-anchors-server-prefix

Author: amaan-bhati

.gitignore

@@ -203,4 +203,4 @@ 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

src/components/GetStartedPaths.js

@@ -1,13 +1,8 @@
 import React from "react";
 import Link from "@docusaurus/Link";
 import useBaseUrl from "@docusaurus/useBaseUrl";
-import {
-  FaRocket,
-  FaMagic,
-  FaRetweet,
-  FaLaptopCode,
-} from "react-icons/fa";
-import { SiKubernetes } from "react-icons/si";
+import {FaRocket, FaMagic, FaRetweet, FaLaptopCode} from "react-icons/fa";
+import {SiKubernetes} from "react-icons/si";
 
 export const GetStartedPaths = () => {
   return (
@@ -21,7 +16,8 @@ export const GetStartedPaths = () => {
           How do you want to get started?
         </h2>
         <p className="mx-auto max-w-2xl text-gray-600 dark:text-gray-400">
-          Pick a workflow to begin. You can switch anytime—both paths lead to reliable, replayable tests.
+          Pick a workflow to begin. You can switch anytime—both paths lead to
+          reliable, replayable tests.
         </p>
       </div>
 
@@ -36,8 +32,8 @@ export const GetStartedPaths = () => {
             {/* Icon Badge */}
             <div className="relative">
               <div className="mb-4 inline-flex items-center justify-center rounded-xl bg-gradient-to-br from-orange-400 to-orange-600 p-3 text-white shadow-lg shadow-orange-500/25">
-              <FaMagic className="h-6 w-6" />
-            </div>
+                <FaMagic className="h-6 w-6" />
+              </div>
             </div>
 
             {/* Path Label */}
@@ -55,7 +51,8 @@ export const GetStartedPaths = () => {
               Generate Tests with Keploy AI
             </h3>
             <p className="mb-4 text-sm text-gray-600 dark:text-gray-400">
-              Generate validated API test suites from OpenAPI, Postman, cURL, or endpoints—then run them across staging/QA.
+              Generate validated API test suites from OpenAPI, Postman, cURL, or
+              endpoints—then run them across staging/QA.
             </p>
 
             {/* Features */}
@@ -83,7 +80,9 @@ export const GetStartedPaths = () => {
             {/* Console Options */}
             <div className="mt-auto space-y-3 pt-2">
               <Link
-                to={useBaseUrl("/docs/running-keploy/generate-api-tests-using-ai/")}
+                to={useBaseUrl(
+                  "/docs/running-keploy/generate-api-tests-using-ai/"
+                )}
                 className="group/option flex items-start justify-between gap-3 rounded-xl border border-gray-200 bg-white/50 p-3 min-h-[92px] transition-all duration-200 hover:border-orange-300 hover:bg-orange-50/50 hover:no-underline dark:border-gray-600 dark:bg-gray-800/50 dark:hover:border-orange-500/50 dark:hover:bg-orange-900/10"
               >
                 <div className="flex items-start gap-3">
@@ -95,15 +94,20 @@ export const GetStartedPaths = () => {
                       Generate from OpenAPI Schema / Postman Collection / cURL
                     </h4>
                     <p className="text-xs text-gray-500 dark:text-gray-400">
-                      Connect resources in Keploy Console and generate validated suites
+                      Connect resources in Keploy Console and generate validated
+                      suites
                     </p>
                   </div>
                 </div>
-                <span className="mt-1 text-gray-400 transition-colors group-hover/option:text-orange-500 dark:text-gray-500">→</span>
+                <span className="mt-1 text-gray-400 transition-colors group-hover/option:text-orange-500 dark:text-gray-500">
+                  →
+                </span>
               </Link>
 
               <Link
-                to={useBaseUrl("/docs/running-keploy/api-testing-chrome-extension/")}
+                to={useBaseUrl(
+                  "/docs/running-keploy/api-testing-chrome-extension/"
+                )}
                 className="group/option flex items-start justify-between gap-3 rounded-xl border border-gray-200 bg-white/50 p-3 min-h-[92px] transition-all duration-200 hover:border-orange-300 hover:bg-orange-50/50 hover:no-underline dark:border-gray-600 dark:bg-gray-800/50 dark:hover:border-orange-500/50 dark:hover:bg-orange-900/10"
               >
                 <div className="flex items-start gap-3">
@@ -119,7 +123,9 @@ export const GetStartedPaths = () => {
                     </p>
                   </div>
                 </div>
-                <span className="mt-1 text-gray-400 transition-colors group-hover/option:text-orange-500 dark:text-gray-500">→</span>
+                <span className="mt-1 text-gray-400 transition-colors group-hover/option:text-orange-500 dark:text-gray-500">
+                  →
+                </span>
               </Link>
             </div>
           </div>
@@ -134,8 +140,8 @@ export const GetStartedPaths = () => {
             {/* Icon Badge */}
             <div className="relative">
               <div className="mb-4 inline-flex items-center justify-center rounded-xl bg-gradient-to-br from-purple-500 to-purple-700 p-3 text-white shadow-lg shadow-purple-500/25">
-              <FaRetweet className="h-6 w-6" />
-            </div>
+                <FaRetweet className="h-6 w-6" />
+              </div>
             </div>
             {/* Path Label */}
             <div className="mb-2 flex items-center gap-2">
@@ -152,21 +158,28 @@ export const GetStartedPaths = () => {
               Record & Replay API Traffic
             </h3>
             <p className="mb-4 text-sm text-gray-600 dark:text-gray-400">
-              Record real API interactions (and dependencies) and replay them deterministically in local or CI.
+              Record real API interactions (and dependencies) and replay them
+              deterministically in local or CI.
             </p>
 
             {/* Highlights */}
             <ul className="mb-6 space-y-2">
               <li className="flex items-center gap-2 text-sm text-gray-600 dark:text-gray-400">
-                <span className="flex h-5 w-5 items-center justify-center rounded-full bg-green-100 text-green-600 dark:bg-green-900/30 dark:text-green-400">✓</span>
+                <span className="flex h-5 w-5 items-center justify-center rounded-full bg-green-100 text-green-600 dark:bg-green-900/30 dark:text-green-400">
+                  ✓
+                </span>
                 Deterministic replays (with mocks)
               </li>
               <li className="flex items-center gap-2 text-sm text-gray-600 dark:text-gray-400">
-                <span className="flex h-5 w-5 items-center justify-center rounded-full bg-green-100 text-green-600 dark:bg-green-900/30 dark:text-green-400">✓</span>
+                <span className="flex h-5 w-5 items-center justify-center rounded-full bg-green-100 text-green-600 dark:bg-green-900/30 dark:text-green-400">
+                  ✓
+                </span>
                 Mocks dependencies automatically
               </li>
               <li className="flex items-center gap-2 text-sm text-gray-600 dark:text-gray-400">
-                <span className="flex h-5 w-5 items-center justify-center rounded-full bg-green-100 text-green-600 dark:bg-green-900/30 dark:text-green-400">✓</span>
+                <span className="flex h-5 w-5 items-center justify-center rounded-full bg-green-100 text-green-600 dark:bg-green-900/30 dark:text-green-400">
+                  ✓
+                </span>
                 Ready for CI pipelines
               </li>
             </ul>
@@ -183,14 +196,16 @@ export const GetStartedPaths = () => {
                   </div>
                   <div>
                     <h4 className="mb-0.5 text-sm font-semibold text-gray-900 dark:text-white">
-                     Record in K8s, Replay Anywhere (Local/CI/K8s)
+                      Record in K8s, Replay Anywhere (Local/CI/K8s)
                     </h4>
                     <p className="text-xs text-gray-500 dark:text-gray-400">
                       Capture from staging/prod, replay in your pipeline
                     </p>
                   </div>
                 </div>
-                <span className="mt-1 text-gray-400 transition-colors group-hover/option:text-purple-500 dark:text-gray-500">→</span>
+                <span className="mt-1 text-gray-400 transition-colors group-hover/option:text-purple-500 dark:text-gray-500">
+                  →
+                </span>
               </Link>
 
               <Link
@@ -204,20 +219,17 @@ export const GetStartedPaths = () => {
                   <div>
                     <h4 className="mb-0.5 flex items-center gap-2 text-sm font-semibold text-gray-900 dark:text-white">
                       Record Locally
-                      <span className="rounded-md bg-purple-50 px-2 py-0.5 text-[10px] font-semibold uppercase tracking-wider text-purple-700 dark:bg-purple-900/30 dark:text-purple-200">
-                        Open Source
-                      </span>
                     </h4>
                     <p className="text-xs text-gray-500 dark:text-gray-400">
-                      Classic Open Source experience for rapid iteration
+                      Classic Keploy CLI experience for rapid iteration
                     </p>
                   </div>
                 </div>
-                <span className="mt-1 text-gray-400 transition-colors group-hover/option:text-purple-500 dark:text-gray-500">→</span>
+                <span className="mt-1 text-gray-400 transition-colors group-hover/option:text-purple-500 dark:text-gray-500">
+                  →
+                </span>
               </Link>
             </div>
-
-
           </div>
         </div>
       </div>

versioned_docs/version-4.0.0/keploy-explained/dev-guide.md

@@ -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.
 
@@ -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';
+
+<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>