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 9bbdd8e49..fc99df2b5 100644 --- a/versioned_docs/version-3.0.0/server/installation_tabs.md +++ b/versioned_docs/version-3.0.0/server/installation_tabs.md @@ -279,12 +279,86 @@ 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** 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. + + ### 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