Skip to content

Commit 3f8e794

Browse files
authored
Add detailed steps for Windows WSL setup (#2402)
* Add detailed steps for Windows WSL setup * clean: Change the keyboard keys formatting on codacy-guardrails-getting-started * clean: Update WSL setup instructions * clean: Fixes for vale issues
1 parent fc5642c commit 3f8e794

1 file changed

Lines changed: 33 additions & 2 deletions

File tree

docs/codacy-guardrails/codacy-guardrails-getting-started.md

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ Besides real-time AI code scanning, Guardrails users can now prompt all their Co
1212
## Prerequisites
1313

1414
- git
15-
- node.js - ensure the `npx` commands runs without issues
15+
- node.js - ensure the `npx` command runs without issues
16+
- curl
1617

1718
### Supported Operating Systems
1819

@@ -43,7 +44,10 @@ Besides real-time AI code scanning, Guardrails users can now prompt all their Co
4344
- dartanalyzer
4445
- [Lizard](https://docs.codacy.com/release-notes/cloud/cloud-2025-02-adding-ruff-lizard/#lizard)
4546

46-
## How to install - Quick Guide
47+
## How to install - Quick Guide {: id="how-to-install-quick-guide"}
48+
49+
#### Note for Windows users:
50+
To take full advantage of Codacy Guardrails on Windows, you might need to setup WSL first, [check the steps here.](#how-to-install-wsl)
4751

4852
### 1. Download the extension
4953

@@ -87,6 +91,33 @@ On the left side menu of the Codacy extension, please make sure that MCP server
8791

8892
### 4. Restart your IDE
8993

94+
## How to install - WSL {: id="how-to-install-wsl"}
95+
96+
### 1. Install or update [WSL.](https://learn.microsoft.com/en-us/windows/wsl/install)
97+
98+
### 2. Install the [WSL extension for VSCode.](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl)
99+
* Ensure you go through all the installation steps and double check all warnings the extension may show during setup, since your machine may require some extra setup steps.
100+
101+
### 3. Open a WSL Window.
102+
* You can do this by using the WSL extension keyboard shortcut `Ctrl` + `Alt` + `O` and then selecting the option or going to the command palette and selecting `WSL: Connect to WSL in New Window`.
103+
104+
### 4. Open your project folder in WSL using the command `WSL: Open Folder in WSL...`.
105+
* Note that the path you need to enter is the WSL path, not the Windows one, so for example if you want to open your project that's in `C:\Users\your_username\project` the equivalent WSL path should be something like `/mnt/c/Users/your_username/project`.
106+
* To double check your path you can always open WSL directly by pressing `Win` + `R` and then typing WSL and pressing enter. There you can check your file structure. Keep in mind that your user folder in WSL (`/home/your_username` or `~`) isn't your user folder in Windows (for example `/mnt/c/Users/your_username`).
107+
* As an alternative, you can also open directly WSL, open your project folder and then opening VSCode from there with the command `code .`.
108+
* If you open a project through Windows explorer, it might open in a new (non-WSL) window. Open it via the command palette instead.
109+
110+
### 5. Install `curl` on your WSL instance if it's not installed already.
111+
* This will depend on the Linux distribution you are using, but for example in Debian and Ubuntu the command will be something like `sudo apt update && sudo apt install curl`.
112+
* You can do this directly in WSL or in VSCode by going to `View > Terminal`.
113+
114+
### 6. Now you should be able to install the Codacy extension without issues. Go through the steps [here](#how-to-install-quick-guide).
115+
* If you already have the extension installed, you will need to enable it for WSL. Check on your `Extensions` tab.
116+
117+
### 7. After everything is set up, you should now be able to interact with Codacy via Copilot.
118+
* Remember that for you to be able to interact with Codacy MCP server, you must be on the `Agent` mode of the chat, not the default `Ask` mode.
119+
* If you're still having issues with the MCP server, try to run the command `Preferences: Open User Settings (JSON)`, look for the Codacy MCP server settings and right on top of it you'll should see a `Start` option. Click on it and, if unsuccessful, go to `View > Debug Console` and check for errors. Don't forget to ensure you have `node.js` and `npx` installed and set up.
120+
90121

91122
## How to install - Manually
92123

0 commit comments

Comments
 (0)