Skip to content

Commit a600033

Browse files
committed
clean: Update WSL setup instructions
1 parent 539bf5b commit a600033

1 file changed

Lines changed: 5 additions & 6 deletions

File tree

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

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,8 @@ Besides real-time AI code scanning, Guardrails users can now prompt all their Co
4646

4747
## How to install - Quick Guide
4848

49-
### 0. Prerequisites
50-
51-
To take full advantage of Codacy Guardrails on **Windows (WSL)**, there might be some prerequisites you need to install first. [Check the setup steps here.](#how-to-install---prerequisites-for-windows-wsl)
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)
5251

5352
### 1. Download the extension
5453

@@ -92,9 +91,9 @@ On the left side menu of the Codacy extension, please make sure that MCP server
9291

9392
### 4. Restart your IDE
9493

95-
## How to install - Prerequisites for Windows (WSL)
94+
## How to install - WSL
9695

97-
### 1. Ensure your machine has `node.js` and `npx` installed.
96+
### 1. Install or update [WSL.](https://learn.microsoft.com/en-us/windows/wsl/install)
9897

9998
### 2. Install the [WSL extension for VSCode.](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl)
10099
* 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, e.g. if your WSL distro version is outdated.
@@ -117,7 +116,7 @@ On the left side menu of the Codacy extension, please make sure that MCP server
117116

118117
### 7. After everything is set up, you should now be able to interact with Codacy via Copilot.
119118
* 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.
120-
* 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.
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` properly installed and set up.
121120

122121

123122
## How to install - Manually

0 commit comments

Comments
 (0)