Skip to content

doc: Update Guardrails setup steps #2422

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nfcodacy merged 2 commits into from
Jul 8, 2025
Merged

doc: Update Guardrails setup steps #2422

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
81408c4
doc: Update Guardrails setup steps
nfcodacy Jul 4, 2025
10ba04a
Merge branch 'master' into update/guardrailsSetupSteps
nfcodacy Jul 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 11 additions & 23 deletions docs/codacy-guardrails/codacy-guardrails-getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
- Windsurf

!!! note
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.
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.

### Built-in Scanners

Expand Down Expand Up @@ -74,6 +74,9 @@
!!! note
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

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

Check failure on line 78 in docs/codacy-guardrails/codacy-guardrails-getting-started.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Foreign] Use 'for example' instead of 'e.g. '.

Raw Output:
{"message": "[Microsoft.Foreign] Use 'for example' instead of 'e.g. '.", "location": {"path": "docs/codacy-guardrails/codacy-guardrails-getting-started.md", "range": {"start": {"line": 78, "column": 70}}}, "severity": "ERROR"}


### 3. Install MCP Server

Expand All @@ -91,33 +94,18 @@

### 4. Restart your IDE

### 5. After everything is set up, you should now be able to interact with Codacy via AI chat.
* 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.
* 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.

## How to install - WSL {: id="how-to-install-wsl"}

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

### 2. Install the [WSL extension for VSCode.](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl)
* 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.

### 3. Open a WSL Window.
* 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`.

### 4. Open your project folder in WSL using the command `WSL: Open Folder in WSL...`.
* 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`.
* 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`).
* As an alternative, you can also open directly WSL, open your project folder and then opening VSCode from there with the command `code .`.
* If you open a project through Windows explorer, it might open in a new (non-WSL) window. Open it via the command palette instead.

### 5. Install `curl` on your WSL instance if it's not installed already.
* 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`.
* You can do this directly in WSL or in VSCode by going to `View > Terminal`.

### 6. Now you should be able to install the Codacy extension without issues. Go through the steps [here](#how-to-install-quick-guide).
* If you already have the extension installed, you will need to enable it for WSL. Check on your `Extensions` tab.

### 7. After everything is set up, you should now be able to interact with Codacy via Copilot.
* 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.
* 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.
### 2. Install `curl` on your WSL instance if it's not installed already.
* 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.

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

## How to install - Manually

Expand Down
Loading