From 708497aeff7c39bbbe788c0ffb9f7dbfec9984fa Mon Sep 17 00:00:00 2001 From: Pratham Sikka Date: Mon, 27 Apr 2026 23:24:21 +0530 Subject: [PATCH 1/2] docs: rewrite installation page and add OSS install to contribution guide - Rewrote server/installation_tabs.md: new intro, numbered sections, login tabs (browser/manual/API key), install output block, updated post-login copy - Appended OSS install section to keploy-explained/dev-guide.md with Linux/macOS/Windows tabs; cleaned up heading emoji and OPEN SOURCE label - Added server/installation entry to version-4.0.0 sidebar - Fixed window.gtag runtime error: stub in headTags + disable gtag in dev Co-Authored-By: Claude Sonnet 4.6 --- .gitignore | 5 +- docusaurus.config.js | 13 +- .../keploy-explained/dev-guide.md | 199 +++++++- .../version-4.0.0/server/installation_tabs.md | 470 +++--------------- .../version-4.0.0-sidebars.json | 5 + 5 files changed, 288 insertions(+), 404 deletions(-) diff --git a/.gitignore b/.gitignore index 39465c1a5..154bdcb00 100644 --- a/.gitignore +++ b/.gitignore @@ -203,4 +203,7 @@ Temporary Items # Support for Project snippet scope -# End of https://www.toptal.com/developers/gitignore/api/macos,linux,jetbrains,visualstudiocode \ No newline at end of file +# End of https://www.toptal.com/developers/gitignore/api/macos,linux,jetbrains,visualstudiocode +.claude/qa-agent/ + +.claude/commands/ \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index 1efe37351..8bdaf30af 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -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", @@ -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 diff --git a/versioned_docs/version-4.0.0/keploy-explained/dev-guide.md b/versioned_docs/version-4.0.0/keploy-explained/dev-guide.md index 2f64ea35f..1fad09573 100644 --- a/versioned_docs/version-4.0.0/keploy-explained/dev-guide.md +++ b/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'; + + + +
+ +:::info +Make sure your Linux kernel version is **5.10 or higher**. +::: + +πŸ‘‰ **Choose your preferred method:** + + + + +### 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**. + + + + + + +### 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**. + + + + + + + +
+ +:::info +Keploy does not natively support macOS. You can run it using **Lima** or **Docker**. +::: + + + + +### 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**. + + + + + + +### 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**. + + + + + + + +
+ +:::info +You can run Keploy using **WSL** or **Docker** on Windows. +::: + + + + +### Install Keploy OSS with WSL + +1. Enable WSL + +```shell +wsl --install -d +``` + +πŸ‘‰ 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**. + + + + + + +### 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**. + + + + + + diff --git a/versioned_docs/version-4.0.0/server/installation_tabs.md b/versioned_docs/version-4.0.0/server/installation_tabs.md index fc99df2b5..a4d49e97f 100644 --- a/versioned_docs/version-4.0.0/server/installation_tabs.md +++ b/versioned_docs/version-4.0.0/server/installation_tabs.md @@ -16,42 +16,26 @@ keywords: - installation --- -import ProductTier from '@site/src/components/ProductTier'; - - - import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -import StartKeploy from '@site/src/components/StartKeploy'; -import StartKeployDocker from '@site/src/components/StartKeployDocker'; # Installing Keploy -Keploy uses eBPF to intercept API calls at the network layer and generate test cases and mocks/stubs. -Choose your OS to get started πŸš€ - - - -
+This guide walks you through installing the Keploy CLI, which enables you to record API calls and replay them as sandboxes for testing. -:::info -Make sure your Linux kernel version is **5.10 or higher**. -::: -πŸ‘‰ **Choose your preferred method:** +## 1. Install Keploy CLI - - -
+Run this command to install Keploy: -### 1. Install Keploy +```bash +curl --silent -O -L https://keploy.io/install.sh && source install.sh +``` - ```bash - curl --silent -O -L https://keploy.io/install.sh && source install.sh - ``` +Once done, you should see something like this: - ### 2. Once done, You should see something like this: +```bash +🐰 Keploy: INFO Starting Keploy {"version": "3.3.8", "buildSource": "unknown", "apiServerURL": "https://api.keploy.io", "inDocker": false} - ```bash β–“β–ˆβ–ˆβ–“β–„ β–“β–“β–“β–“β–ˆβ–ˆβ–“β–ˆβ–“β–„ β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–“β–’ @@ -60,425 +44,115 @@ Make sure your Linux kernel version is **5.10 or higher**. β–“β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–Œβ–“β–“ β–ˆβ–ˆβ–“β–ˆβ–„ β–“β–ˆβ–„β–“β–“ β–β–ˆβ–Œ β–ˆβ–ˆ β–“β–ˆ β–ˆβ–Œ β–ˆβ–ˆ β–ˆβ–Œ β–ˆβ–“ β–“β–“β–“β–“β–€β–€β–€β–€β–“β–“β–“β–“β–“β–“β–Œ β–ˆβ–ˆ β–ˆβ–“ β–“β–Œβ–„β–„ β–β–ˆβ–“β–„β–“β–ˆβ–€ β–ˆβ–“β–ˆ β–€β–ˆβ–„β–„β–ˆβ–€ β–ˆβ–“β–ˆ β–“β–Œ β–β–ˆβ–Œ β–ˆβ–Œ - β–“ + β–“ COMMUNITY EDITION - Keploy CLI +Keploy: 3.3.8 - 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 +Golang Application + Record: + keploy record -c "/path/to/user/app/binary" - Use "keploy [command] --help" for more information about a command. - ``` + Test: + keploy test -c "/path/to/user/app/binary" --delay 10 -## πŸŽ‰ Congratulations! +Node Application + Record: + keploy record -c "npm start --prefix /path/to/node/app" -You’ve successfully installed **Keploy on Linux**. + Test: + keploy test -c "npm start --prefix /path/to/node/app" --delay 10 - - +Java + Record: + keploy record -c "java -jar /path/to/java-project/target/jar" - + Test: + keploy test -c "java -jar /path/to/java-project/target/jar" --delay 10 -## Install Keploy with Docker on Linux +Docker + Record: + keploy record -c "docker run -p 8080:8080 --name --network " --buildDelay 60 -1. **Make sure Docker is installed**: You’ll need Docker installed on Linux + Test: + keploy test -c "docker run -p 8080:8080 --name --network " --delay 1 --buildDelay 60 -2. **Install Keploy** -```bash - curl --silent -O -L https://keploy.io/install.sh && source install.sh -``` +Note: If installed without One Click Install, use "keploy example --customSetup true" -3. **Once done, You should see something like this:** -```bash - β–“β–ˆβ–ˆβ–“β–„ - β–“β–“β–“β–“β–ˆβ–ˆβ–“β–ˆβ–“β–„ - β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–“β–’ - β–€β–“β–“β–ˆβ–ˆβ–ˆβ–„ β–„β–„ β–„ β–Œ - β–„β–Œβ–Œβ–“β–“β–ˆβ–ˆβ–ˆβ–ˆβ–„ β–ˆβ–ˆ β–“β–ˆβ–€ β–„β–Œβ–€β–„ β–“β–“β–Œβ–„ β–“β–ˆ β–„β–Œβ–“β–“β–Œβ–„ β–Œβ–Œ β–“ - β–“β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–Œβ–“β–“ β–ˆβ–ˆβ–“β–ˆβ–„ β–“β–ˆβ–„β–“β–“ β–β–ˆβ–Œ β–ˆβ–ˆ β–“β–ˆ β–ˆβ–Œ β–ˆβ–ˆ β–ˆβ–Œ β–ˆβ–“ - β–“β–“β–“β–“β–€β–€β–€β–€β–“β–“β–“β–“β–“β–“β–Œ β–ˆβ–ˆ β–ˆβ–“ β–“β–Œβ–„β–„ β–β–ˆβ–“β–„β–“β–ˆβ–€ β–ˆβ–“β–ˆ β–€β–ˆβ–„β–„β–ˆβ–€ β–ˆβ–“β–ˆ - β–“β–Œ β–β–ˆβ–Œ β–ˆβ–Œ - β–“ - - Keploy CLI - - 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. +Please log in to your Keploy account to access the paid features. +You can log in by running the 'keploy login' command. ``` -## πŸŽ‰ Congratulations! - -You’ve successfully set up **Keploy on Linux** using **Docker**. +## 2. Log in to Keploy - - - - - - -
-:::info -Keploy does not natively support macOS. However, you can run it using **Lima** or **Docker**. -::: - -πŸ‘‰ **Choose your preferred method:** +After installing, authenticate with your Keploy account. +Choose the method that fits your setup: + - - -## Install Keploy with Lima - -1. **Check if Lima is installed**: If you already have Lima, Go to Step 6. - -2. **Install Lima** +Keploy opens a browser window to sign you in automatically: ```bash -brew install lima +keploy login ``` -3. **Create a Debian instance** \[or any instance of your choice] - ```bash -limactl create template://debian-12 -``` +Opening browser for authentication... -4. **Start the instance** +If the browser does not open automatically, please visit: +https://app.keploy.io/signin/integration/auth?method=code&code= -```bash -limactl start debian-12 +Waiting for authentication... +Logged in successfully! ``` -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 -``` + + -7. **Once done, You should see something like this:** +If a browser cannot open (for example in a remote terminal): ```bash - β–“β–ˆβ–ˆβ–“β–„ - β–“β–“β–“β–“β–ˆβ–ˆβ–“β–ˆβ–“β–„ - β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–“β–’ - β–€β–“β–“β–ˆβ–ˆβ–ˆβ–„ β–„β–„ β–„ β–Œ - β–„β–Œβ–Œβ–“β–“β–ˆβ–ˆβ–ˆβ–ˆβ–„ β–ˆβ–ˆ β–“β–ˆβ–€ β–„β–Œβ–€β–„ β–“β–“β–Œβ–„ β–“β–ˆ β–„β–Œβ–“β–“β–Œβ–„ β–Œβ–Œ β–“ - β–“β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–Œβ–“β–“ β–ˆβ–ˆβ–“β–ˆβ–„ β–“β–ˆβ–„β–“β–“ β–β–ˆβ–Œ β–ˆβ–ˆ β–“β–ˆ β–ˆβ–Œ β–ˆβ–ˆ β–ˆβ–Œ β–ˆβ–“ - β–“β–“β–“β–“β–€β–€β–€β–€β–“β–“β–“β–“β–“β–“β–Œ β–ˆβ–ˆ β–ˆβ–“ β–“β–Œβ–„β–„ β–β–ˆβ–“β–„β–“β–ˆβ–€ β–ˆβ–“β–ˆ β–€β–ˆβ–„β–„β–ˆβ–€ β–ˆβ–“β–ˆ - β–“β–Œ β–β–ˆβ–Œ β–ˆβ–Œ - β–“ - -Keploy CLI - -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. +keploy login --manual-login ``` -## πŸŽ‰ Congratulations! - -You’ve successfully set up **Keploy on macOS** using **Lima**. - - - + - - -## Install Keploy with Docker on macOS - -1. **Make sure Docker is installed**: You’ll need Docker Desktop running on macOS. - -2. **Install Keploy** +For CI/CD environments, authenticate using an API key: ```bash -curl --silent -O -L https://keploy.io/install.sh && source install.sh +keploy login --api-key ``` -3. **Verify the installation** - - **Once done, You should see something like this:** +You can also set it as an environment variable: ```bash - β–“β–ˆβ–ˆβ–“β–„ - β–“β–“β–“β–“β–ˆβ–ˆβ–“β–ˆβ–“β–„ - β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–“β–’ - β–€β–“β–“β–ˆβ–ˆβ–ˆβ–„ β–„β–„ β–„ β–Œ - β–„β–Œβ–Œβ–“β–“β–ˆβ–ˆβ–ˆβ–ˆβ–„ β–ˆβ–ˆ β–“β–ˆβ–€ β–„β–Œβ–€β–„ β–“β–“β–Œβ–„ β–“β–ˆ β–„β–Œβ–“β–“β–Œβ–„ β–Œβ–Œ β–“ - β–“β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–Œβ–“β–“ β–ˆβ–ˆβ–“β–ˆβ–„ β–“β–ˆβ–„β–“β–“ β–β–ˆβ–Œ β–ˆβ–ˆ β–“β–ˆ β–ˆβ–Œ β–ˆβ–ˆ β–ˆβ–Œ β–ˆβ–“ - β–“β–“β–“β–“β–€β–€β–€β–€β–“β–“β–“β–“β–“β–“β–Œ β–ˆβ–ˆ β–ˆβ–“ β–“β–Œβ–„β–„ β–β–ˆβ–“β–„β–“β–ˆβ–€ β–ˆβ–“β–ˆ β–€β–ˆβ–„β–„β–ˆβ–€ β–ˆβ–“β–ˆ - β–“β–Œ β–β–ˆβ–Œ β–ˆβ–Œ - β–“ - -Keploy CLI - -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. +export KEPLOY_API_KEY= ``` -## πŸŽ‰ Congratulations! - -You’ve successfully set up **Keploy on macOS** using **Docker**. - - +### How to get your API key + +1. Log in to [app.keploy.io](https://app.keploy.io) +2. Click on your **user profile** at the bottom left +3. Go to **Account Settings** +4. In the sidebar, select **API Keys** +5. Click **Generate new token** +6. Fill in the details: + - **Token name** β€” give it a recognizable name + - **Scopes** β€” select the access level you need: + - **Read** β€” read-only access to resources + - **Write** β€” read and write access + - **Admin** β€” full administrative access + - **Expiration** β€” default is 90 days +7. Click **Generate token** +8. **Copy the token immediately** β€” it will not be shown again - - - -
- -:::info -You can run Keploy **Natively** or using **WSL** or **Docker**. If you want to run Keploy natively, make sure to do it as an administrator. -::: - -πŸ‘‰ **Choose your preferred method:** - - - -
- -`Note: Native Windows support is available only for AMD. For ARM-based systems, please use WSL or Docker.` - -### 1. Create a Directory - - Use this command to create a directory for Keploy: - - ```powershell - - New-Item -ItemType Directory -Force -Path "$env:APPDATA\Keploy\bin" - ``` - - ### 2. Install Keploy - - Run this command to install the Keploy exe: - - ```powershell - Invoke-WebRequest -Uri "https://github.com/keploy/keploy/releases/latest/download/keploy_windows_amd64.exe" -OutFile "$env:APPDATA\Keploy\bin\keploy.exe" - ``` - - ### 3. Set Environment Variable - -Add the directory containing the Keploy binary to your system user’s `PATH` environment variable to make the `keploy` command available globally. - - ```text - C:\Users\"Your Username"\AppData\Roaming\Keploy\bin - ``` - - ### 4. Finalize Setup - 1. Checks: Close all the terminals. - 2. Run as Admin: Open your terminal as **Administrator**. - 3. Troubleshooting: If you face issues, ensure `cmd.exe` and `powershell.exe` (default paths in Windows) are in your system environment variables. +Now you can start using Keploy to record API calls and replay them as sandboxes for testing your application. - ### 5. Verify Installation - - Once done, You should see something like this: - - ```bash - β–“β–ˆβ–ˆβ–“β–„ - β–“β–“β–“β–“β–ˆβ–ˆβ–“β–ˆβ–“β–„ - β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–“β–’ - β–€β–“β–“β–ˆβ–ˆβ–ˆβ–„ β–„β–„ β–„ β–Œ - β–„β–Œβ–Œβ–“β–“β–ˆβ–ˆβ–ˆβ–ˆβ–„ β–ˆβ–ˆ β–“β–ˆβ–€ β–„β–Œβ–€β–„ β–“β–“β–Œβ–„ β–“β–ˆ β–„β–Œβ–“β–“β–Œβ–„ β–Œβ–Œ β–“ - β–“β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–Œβ–“β–“ β–ˆβ–ˆβ–“β–ˆβ–„ β–“β–ˆβ–„β–“β–“ β–β–ˆβ–Œ β–ˆβ–ˆ β–“β–ˆ β–ˆβ–Œ β–ˆβ–ˆ β–ˆβ–Œ β–ˆβ–“ - β–“β–“β–“β–“β–€β–€β–€β–€β–“β–“β–“β–“β–“β–“β–Œ β–ˆβ–ˆ β–ˆβ–“ β–“β–Œβ–„β–„ β–β–ˆβ–“β–„β–“β–ˆβ–€ β–ˆβ–“β–ˆ β–€β–ˆβ–„β–„β–ˆβ–€ β–ˆβ–“β–ˆ - β–“β–Œ β–β–ˆβ–Œ β–ˆβ–Œ - β–“ - - Keploy CLI - - 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. - ``` -## πŸŽ‰ Congratulations! - -You’ve successfully installed **Keploy on Windows**. - - - - - - -## Install Keploy with WSL - -If you already have WSL, Go to Step 2. - -Note: Make sure you’re on: - -- **Windows 10** (version 2004 or later, build 19041+) -- **Windows 11** - -Run the following command in PowerShell (as Administrator): - -1. **Enable WSL** - -```shell -wsl --install -d -``` - -πŸ‘‰ We recommend using **Ubuntu-22.04** for the best experience. -(You can also choose a different distribution if needed.) - -2. **Install Keploy Binary** - Inside your WSL terminal, run: - -```shell -curl --silent -O -L https://keploy.io/install.sh && source install.sh -``` - -3. **Verify Installation** - -```bash - β–“β–ˆβ–ˆβ–“β–„ - β–“β–“β–“β–“β–ˆβ–ˆβ–“β–ˆβ–“β–„ - β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–“β–’ - β–€β–“β–“β–ˆβ–ˆβ–ˆβ–„ β–„β–„ β–„ β–Œ - β–„β–Œβ–Œβ–“β–“β–ˆβ–ˆβ–ˆβ–ˆβ–„ β–ˆβ–ˆ β–“β–ˆβ–€ β–„β–Œβ–€β–„ β–“β–“β–Œβ–„ β–“β–ˆ β–„β–Œβ–“β–“β–Œβ–„ β–Œβ–Œ β–“ - β–“β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–Œβ–“β–“ β–ˆβ–ˆβ–“β–ˆβ–„ β–“β–ˆβ–„β–“β–“ β–β–ˆβ–Œ β–ˆβ–ˆ β–“β–ˆ β–ˆβ–Œ β–ˆβ–ˆ β–ˆβ–Œ β–ˆβ–“ - β–“β–“β–“β–“β–€β–€β–€β–€β–“β–“β–“β–“β–“β–“β–Œ β–ˆβ–ˆ β–ˆβ–“ β–“β–Œβ–„β–„ β–β–ˆβ–“β–„β–“β–ˆβ–€ β–ˆβ–“β–ˆ β–€β–ˆβ–„β–„β–ˆβ–€ β–ˆβ–“β–ˆ - β–“β–Œ β–β–ˆβ–Œ β–ˆβ–Œ - β–“ - -Keploy CLI - -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. -``` - -## πŸŽ‰ Congratulations! - -You’ve successfully set up **Keploy on Windows** using **WSL**. - - - - - - - -## Install Keploy with Docker on Windows - -1. **Make sure Docker is installed** : You’ll need **Docker Desktop** running on Windows. - -2. **Install Keploy** - -```bash -curl --silent -O -L https://keploy.io/install.sh && source install.sh -``` - -3. **Verify the installation** - -**Once done, You should see something like this:** - -```bash - - β–“β–ˆβ–ˆβ–“β–„ - β–“β–“β–“β–“β–ˆβ–ˆβ–“β–ˆβ–“β–„ - β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–“β–’ - β–€β–“β–“β–ˆβ–ˆβ–ˆβ–„ β–„β–„ β–„ β–Œ - β–„β–Œβ–Œβ–“β–“β–ˆβ–ˆβ–ˆβ–ˆβ–„ β–ˆβ–ˆ β–“β–ˆβ–€ β–„β–Œβ–€β–„ β–“β–“β–Œβ–„ β–“β–ˆ β–„β–Œβ–“β–“β–Œβ–„ β–Œβ–Œ β–“ - β–“β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–Œβ–“β–“ β–ˆβ–ˆβ–“β–ˆβ–„ β–“β–ˆβ–„β–“β–“ β–β–ˆβ–Œ β–ˆβ–ˆ β–“β–ˆ β–ˆβ–Œ β–ˆβ–ˆ β–ˆβ–Œ β–ˆβ–“ - β–“β–“β–“β–“β–€β–€β–€β–€β–“β–“β–“β–“β–“β–“β–Œ β–ˆβ–ˆ β–ˆβ–“ β–“β–Œβ–„β–„ β–β–ˆβ–“β–„β–“β–ˆβ–€ β–ˆβ–“β–ˆ β–€β–ˆβ–„β–„β–ˆβ–€ β–ˆβ–“β–ˆ - β–“β–Œ β–β–ˆβ–Œ β–ˆβ–Œ - β–“ - -Keploy CLI - -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. - -``` - -## πŸŽ‰ Congratulations! - -You’ve successfully set up **Keploy on Windows** using **Docker**. - - - - - - - +To explore what's available at each tier, visit [keploy.io/pricing](https://keploy.io/pricing). diff --git a/versioned_sidebars/version-4.0.0-sidebars.json b/versioned_sidebars/version-4.0.0-sidebars.json index d5e7e313a..6e704e591 100644 --- a/versioned_sidebars/version-4.0.0-sidebars.json +++ b/versioned_sidebars/version-4.0.0-sidebars.json @@ -20,6 +20,11 @@ "collapsible": true, "collapsed": true, "items": [ + { + "type": "doc", + "label": "Installation", + "id": "server/installation" + }, { "type": "doc", "label": "Local", From f2964ab726e9ab56348b62942b2696f3f54ec250 Mon Sep 17 00:00:00 2001 From: Pratham Sikka Date: Wed, 29 Apr 2026 20:02:16 +0530 Subject: [PATCH 2/2] docs: update login tabs with API key steps and success message --- .../version-4.0.0/server/installation_tabs.md | 33 ++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/versioned_docs/version-4.0.0/server/installation_tabs.md b/versioned_docs/version-4.0.0/server/installation_tabs.md index a4d49e97f..51abc899b 100644 --- a/versioned_docs/version-4.0.0/server/installation_tabs.md +++ b/versioned_docs/version-4.0.0/server/installation_tabs.md @@ -44,7 +44,7 @@ Once done, you should see something like this: β–“β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–Œβ–“β–“ β–ˆβ–ˆβ–“β–ˆβ–„ β–“β–ˆβ–„β–“β–“ β–β–ˆβ–Œ β–ˆβ–ˆ β–“β–ˆ β–ˆβ–Œ β–ˆβ–ˆ β–ˆβ–Œ β–ˆβ–“ β–“β–“β–“β–“β–€β–€β–€β–€β–“β–“β–“β–“β–“β–“β–Œ β–ˆβ–ˆ β–ˆβ–“ β–“β–Œβ–„β–„ β–β–ˆβ–“β–„β–“β–ˆβ–€ β–ˆβ–“β–ˆ β–€β–ˆβ–„β–„β–ˆβ–€ β–ˆβ–“β–ˆ β–“β–Œ β–β–ˆβ–Œ β–ˆβ–Œ - β–“ COMMUNITY EDITION + β–“ Keploy: 3.3.8 @@ -118,6 +118,30 @@ If a browser cannot open (for example in a remote terminal): keploy login --manual-login ``` +When prompted, enter your Keploy API key. To get your API key: + +1. Log in to [app.keploy.io](https://app.keploy.io) +2. Click on your **user profile** at the bottom left +3. Go to **Account Settings** +4. In the sidebar, select **API Keys** +5. Click **Generate new token** +6. Fill in the details: + - **Token name** β€” give it a recognizable name + - **Scopes** β€” select the access level you need: + - **Read** β€” read-only access to resources + - **Write** β€” read and write access + - **Admin** β€” full administrative access + - **Expiration** β€” default is 90 days +7. Click **Generate token** +8. **Copy the token immediately** β€” it will not be shown again + +Once your API key is verified, you will see: + +```bash +API key verified successfully! +You are on the Keploy Community plan. +``` + @@ -150,6 +174,13 @@ export KEPLOY_API_KEY= 7. Click **Generate token** 8. **Copy the token immediately** β€” it will not be shown again +Once your API key is verified, you will see: + +```bash +API key verified successfully! +You are on the Keploy Community plan. +``` +