You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/codacy-guardrails/codacy-guardrails-getting-started.md
+11-23Lines changed: 11 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ Besides real-time AI code scanning, Guardrails users can now prompt all their Co
32
32
- Windsurf
33
33
34
34
!!! note
35
-
Visual Studio CodeInsiders 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.
36
36
37
37
### Built-in Scanners
38
38
@@ -74,6 +74,9 @@ It will create a folder in your local repository called **.codacy** with all nee
74
74
!!! note
75
75
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
76
76
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
+
77
80
78
81
### 3. Install MCP Server
79
82
@@ -91,33 +94,18 @@ On the left side menu of the Codacy extension, please make sure that MCP server
91
94
92
95
### 4. Restart your IDE
93
96
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
+
94
101
## How to install - WSL {: id="how-to-install-wsl"}
95
102
96
103
### 1. Install or update [WSL.](https://learn.microsoft.com/en-us/windows/wsl/install)
97
104
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.
120
107
108
+
### 3. Now you should be able to install the Codacy extension without issues. Go through the steps [here](#how-to-install-quick-guide).
0 commit comments