Skip to content

Commit 81408c4

Browse files
committed
doc: Update Guardrails setup steps
1 parent c7373c8 commit 81408c4

1 file changed

Lines changed: 11 additions & 23 deletions

File tree

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

Lines changed: 11 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Besides real-time AI code scanning, Guardrails users can now prompt all their Co
3232
- Windsurf
3333

3434
!!! note
35-
Visual Studio Code Insiders is recommended for its faster performance and compatibility with Codacy Guardrails. However, since it's a beta version, you may encounter occasional issues.
35+
For Visual Studio Code, the Insiders version is recommended for its faster performance and compatibility with Codacy Guardrails. However, since it's a beta version, you may encounter occasional issues.
3636

3737
### Built-in Scanners
3838

@@ -74,6 +74,9 @@ It will create a folder in your local repository called **.codacy** with all nee
7474
!!! note
7575
If you don't want this folder to be part of your repository in future commits but continue working with it locally, please add **.codacy** to your .gitignore file
7676

77+
!!! note
78+
The IDE extension will ignore any CLI version already installed (e.g. through brew or other package manager) on the machine.
79+
7780

7881
### 3. Install MCP Server
7982

@@ -91,33 +94,18 @@ On the left side menu of the Codacy extension, please make sure that MCP server
9194

9295
### 4. Restart your IDE
9396

97+
### 5. After everything is set up, you should now be able to interact with Codacy via AI chat.
98+
* 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.
99+
* 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.
100+
94101
## How to install - WSL {: id="how-to-install-wsl"}
95102

96103
### 1. Install or update [WSL.](https://learn.microsoft.com/en-us/windows/wsl/install)
97104

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.
105+
### 2. Install `curl` on your WSL instance if it's not installed already.
106+
* 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`. Execute the command on a WSL terminal.
120107

108+
### 3. Now you should be able to install the Codacy extension without issues. Go through the steps [here](#how-to-install-quick-guide).
121109

122110
## How to install - Manually
123111

0 commit comments

Comments
 (0)