From 3aef8af0c8e6463b53f169e8b31cc164b3593f1a Mon Sep 17 00:00:00 2001 From: amaan-bhati Date: Fri, 16 Jan 2026 16:27:52 +0530 Subject: [PATCH 1/5] feat: update docs for the new windows native support Signed-off-by: amaan-bhati --- .../version-3.0.0/server/installation_tabs.md | 48 ++++++++++++++++++- 1 file changed, 47 insertions(+), 1 deletion(-) diff --git a/versioned_docs/version-3.0.0/server/installation_tabs.md b/versioned_docs/version-3.0.0/server/installation_tabs.md index 51f87bf77..8fd85722e 100644 --- a/versioned_docs/version-3.0.0/server/installation_tabs.md +++ b/versioned_docs/version-3.0.0/server/installation_tabs.md @@ -275,12 +275,58 @@ You’ve successfully set up **Keploy on macOS** using **Docker**.
:::info -Keploy does not natively support Windows. However, you can run it using **WSL** or **Docker**. +You can run Keploy **Natively**, using **WSL** or **Docker**. If you are trying to install Keploy natively, make sure to do it as an administrator. ::: πŸ‘‰ **Choose your preferred method:** + +
+ +### 1. Install Keploy + + ```bash + curl --silent -O -L https://keploy.io/install.sh && source install.sh + ``` + + ### 2. 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 From f3ea07b8e399b7e5d981fb1a6d091b6fe14083a8 Mon Sep 17 00:00:00 2001 From: Amaan Bhati <94218318+amaan-bhati@users.noreply.github.com> Date: Fri, 16 Jan 2026 16:57:09 +0530 Subject: [PATCH 2/5] chore: minor improvement in content Signed-off-by: Amaan Bhati <94218318+amaan-bhati@users.noreply.github.com> --- versioned_docs/version-3.0.0/server/installation_tabs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/versioned_docs/version-3.0.0/server/installation_tabs.md b/versioned_docs/version-3.0.0/server/installation_tabs.md index 99a5ac545..182eb2946 100644 --- a/versioned_docs/version-3.0.0/server/installation_tabs.md +++ b/versioned_docs/version-3.0.0/server/installation_tabs.md @@ -279,7 +279,7 @@ You’ve successfully set up **Keploy on macOS** using **Docker**.
:::info -You can run Keploy **Natively**, using **WSL** or **Docker**. If you are trying to install Keploy natively, make sure to do it as an administrator. +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:** From eca352fb0ba43ee6a486b24301447fccab029235 Mon Sep 17 00:00:00 2001 From: amaan-bhati Date: Fri, 16 Jan 2026 23:22:48 +0530 Subject: [PATCH 3/5] feat: change the windows native installation steps with the exe installation commands Signed-off-by: amaan-bhati --- .../version-3.0.0/server/installation_tabs.md | 35 ++++++++++++++++--- 1 file changed, 30 insertions(+), 5 deletions(-) diff --git a/versioned_docs/version-3.0.0/server/installation_tabs.md b/versioned_docs/version-3.0.0/server/installation_tabs.md index 182eb2946..ca2a9f4e0 100644 --- a/versioned_docs/version-3.0.0/server/installation_tabs.md +++ b/versioned_docs/version-3.0.0/server/installation_tabs.md @@ -288,13 +288,39 @@ You can run Keploy **Natively** or using **WSL** or **Docker**. If you want to r
-### 1. Install Keploy +### 1. Create a Directory - ```bash - curl --silent -O -L https://keploy.io/install.sh && source install.sh + Use this command to create a directory for Keploy: + + ```powershell + New-Item -ItemType Directory -Force -Path "$env:APPDATA\Keploy\bin" ``` - ### 2. Once done, You should see something like this: + ### 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 following path to your System User Settings Environment Variables: + + ```text + C:\Users\"Your User"\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. + + ### 5. Verify Installation + + Once done, You should see something like this: ```bash β–“β–ˆβ–ˆβ–“β–„ @@ -323,7 +349,6 @@ You can run Keploy **Natively** or using **WSL** or **Docker**. If you want to r Use "keploy [command] --help" for more information about a command. ``` - ## πŸŽ‰ Congratulations! You’ve successfully installed **Keploy on Windows**. From 561d062a647a6c37c7109ad205fff69f1cab7e16 Mon Sep 17 00:00:00 2001 From: Achanandhi-M Date: Tue, 20 Jan 2026 15:46:29 +0530 Subject: [PATCH 4/5] feat: update env section Signed-off-by: Achanandhi-M --- versioned_docs/version-3.0.0/server/installation_tabs.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/versioned_docs/version-3.0.0/server/installation_tabs.md b/versioned_docs/version-3.0.0/server/installation_tabs.md index ca2a9f4e0..262e4dbe7 100644 --- a/versioned_docs/version-3.0.0/server/installation_tabs.md +++ b/versioned_docs/version-3.0.0/server/installation_tabs.md @@ -293,6 +293,7 @@ You can run Keploy **Natively** or using **WSL** or **Docker**. If you want to r Use this command to create a directory for Keploy: ```powershell + New-Item -ItemType Directory -Force -Path "$env:APPDATA\Keploy\bin" ``` @@ -306,10 +307,10 @@ You can run Keploy **Natively** or using **WSL** or **Docker**. If you want to r ### 3. Set Environment Variable - Add the following path to your System User Settings Environment Variables: +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 User"\AppData\Roaming\Keploy\bin + C:\Users\"Your Username"\AppData\Roaming\Keploy\bin ``` ### 4. Finalize Setup From 47988ff67944163162babef6b12ef2a175e75227 Mon Sep 17 00:00:00 2001 From: Achanandhi-M Date: Tue, 20 Jan 2026 16:03:27 +0530 Subject: [PATCH 5/5] feat: added note section Signed-off-by: Achanandhi-M --- versioned_docs/version-3.0.0/server/installation_tabs.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/versioned_docs/version-3.0.0/server/installation_tabs.md b/versioned_docs/version-3.0.0/server/installation_tabs.md index 262e4dbe7..fc99df2b5 100644 --- a/versioned_docs/version-3.0.0/server/installation_tabs.md +++ b/versioned_docs/version-3.0.0/server/installation_tabs.md @@ -288,6 +288,8 @@ You can run Keploy **Natively** or using **WSL** or **Docker**. If you want to r
+`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: