Skip to content

Commit ebcb2cd

Browse files
feat: update docs for the windows native support (#753)
* feat: update docs for the new windows native support Signed-off-by: amaan-bhati <amaanbhati49@gmail.com> * chore: minor improvement in content Signed-off-by: Amaan Bhati <94218318+amaan-bhati@users.noreply.github.com> * feat: change the windows native installation steps with the exe installation commands Signed-off-by: amaan-bhati <amaanbhati49@gmail.com> * feat: update env section Signed-off-by: Achanandhi-M <achanandhi.m@gmail.com> * feat: added note section Signed-off-by: Achanandhi-M <achanandhi.m@gmail.com> --------- Signed-off-by: amaan-bhati <amaanbhati49@gmail.com> Signed-off-by: Amaan Bhati <94218318+amaan-bhati@users.noreply.github.com> Signed-off-by: Achanandhi-M <achanandhi.m@gmail.com> Co-authored-by: Achanandhi-M <achanandhi.m@gmail.com>
1 parent 77ef4ef commit ebcb2cd

1 file changed

Lines changed: 75 additions & 1 deletion

File tree

versioned_docs/version-3.0.0/server/installation_tabs.md

Lines changed: 75 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -279,12 +279,86 @@ You’ve successfully set up **Keploy on macOS** using **Docker**.
279279
<br />
280280

281281
:::info
282-
Keploy does not natively support Windows. However, you can run it using **WSL** or **Docker**.
282+
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.
283283
:::
284284

285285
👉 **Choose your preferred method:**
286286

287287
<Tabs>
288+
<TabItem value="windows-native" label="Native">
289+
<br />
290+
291+
`Note: Native Windows support is available only for AMD. For ARM-based systems, please use WSL or Docker.`
292+
293+
### 1. Create a Directory
294+
295+
Use this command to create a directory for Keploy:
296+
297+
```powershell
298+
299+
New-Item -ItemType Directory -Force -Path "$env:APPDATA\Keploy\bin"
300+
```
301+
302+
### 2. Install Keploy
303+
304+
Run this command to install the Keploy exe:
305+
306+
```powershell
307+
Invoke-WebRequest -Uri "https://github.com/keploy/keploy/releases/latest/download/keploy_windows_amd64.exe" -OutFile "$env:APPDATA\Keploy\bin\keploy.exe"
308+
```
309+
310+
### 3. Set Environment Variable
311+
312+
Add the directory containing the Keploy binary to your system user’s `PATH` environment variable to make the `keploy` command available globally.
313+
314+
```text
315+
C:\Users\"Your Username"\AppData\Roaming\Keploy\bin
316+
```
317+
318+
### 4. Finalize Setup
319+
320+
1. Checks: Close all the terminals.
321+
2. Run as Admin: Open your terminal as **Administrator**.
322+
3. Troubleshooting: If you face issues, ensure `cmd.exe` and `powershell.exe` (default paths in Windows) are in your system environment variables.
323+
324+
### 5. Verify Installation
325+
326+
Once done, You should see something like this:
327+
328+
```bash
329+
▓██▓▄
330+
▓▓▓▓██▓█▓▄
331+
████████▓▒
332+
▀▓▓███▄ ▄▄ ▄ ▌
333+
▄▌▌▓▓████▄ ██ ▓█▀ ▄▌▀▄ ▓▓▌▄ ▓█ ▄▌▓▓▌▄ ▌▌ ▓
334+
▓█████████▌▓▓ ██▓█▄ ▓█▄▓▓ ▐█▌ ██ ▓█ █▌ ██ █▌ █▓
335+
▓▓▓▓▀▀▀▀▓▓▓▓▓▓▌ ██ █▓ ▓▌▄▄ ▐█▓▄▓█▀ █▓█ ▀█▄▄█▀ █▓█
336+
▓▌ ▐█▌ █▌
337+
338+
339+
Keploy CLI
340+
341+
Available Commands:
342+
example Example to record and test via keploy
343+
config --generate generate the keploy configuration file
344+
record record the keploy testcases from the API calls
345+
test run the recorded testcases and execute assertions
346+
update Update Keploy
347+
348+
Flags:
349+
--debug Run in debug mode
350+
-h, --help help for keploy
351+
-v, --version version for keploy
352+
353+
Use "keploy [command] --help" for more information about a command.
354+
```
355+
## 🎉 Congratulations!
356+
357+
You’ve successfully installed **Keploy on Windows**.
358+
359+
<StartKeploy />
360+
</TabItem>
361+
288362
<TabItem value="wsl" label="WSL">
289363

290364
## Install Keploy with WSL

0 commit comments

Comments
 (0)