Skip to content

Add detailed steps for Windows WSL setup #2402

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 4 commits into from
May 29, 2025
Merged

Add detailed steps for Windows WSL setup #2402

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c58e092
Add detailed steps for Windows WSL setup
nfcodacy May 29, 2025
539bf5b
clean: Change the keyboard keys formatting on codacy-guardrails-getti…
nfcodacy May 29, 2025
a600033
clean: Update WSL setup instructions
nfcodacy May 29, 2025
a231111
clean: Fixes for vale issues
nfcodacy May 29, 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: 33 additions & 1 deletion 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 @@ -12,7 +12,8 @@
## Prerequisites

- git
- node.js - ensure the `npx` commands runs without issues
- node.js - ensure the `npx` command runs without issues
- curl

### Supported Operating Systems

Expand Down Expand Up @@ -45,6 +46,10 @@

## How to install - Quick Guide

### 0. Prerequisites

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)

### 1. Download the extension

- [Visual Studio Code](https://tinyurl.com/codacy-vscode)
Expand Down Expand Up @@ -87,6 +92,33 @@

### 4. Restart your IDE

## How to install - Prerequisites for Windows (WSL)

### 1. Ensure your machine has `node.js` and `npx` installed.
Comment thread
nfcodacy marked this conversation as resolved.
Outdated

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

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

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'distro'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'distro'?", "location": {"path": "docs/codacy-guardrails/codacy-guardrails-getting-started.md", "range": {"start": {"line": 100, "column": 191}}}, "severity": "ERROR"}

Check failure on line 100 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": 100, "column": 174}}}, "severity": "ERROR"}

### 3. Open a WSL Window.
* You can do this by using the WSL extension keyboard shortcut <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>O</kbd> 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 is in `C:\Users\your_username\project` the equivalent WSL path should be something like `/mnt/c/Users/your_username/project`.

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

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'that's' instead of 'that is'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'that's' instead of 'that is'.", "location": {"path": "docs/codacy-guardrails/codacy-guardrails-getting-started.md", "range": {"start": {"line": 106, "column": 126}}}, "severity": "ERROR"}
* To double check your path you can always open WSL directly by pressing <kbd>Win</kbd> + <kbd>R</kbd> 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 `~`) is NOT your user folder in Windows (e.g. `/mnt/c/Users/your_username`).

Check failure on line 107 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": 107, "column": 294}}}, "severity": "ERROR"}

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

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'isn't' instead of 'is NOT'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'isn't' instead of 'is NOT'.", "location": {"path": "docs/codacy-guardrails/codacy-guardrails-getting-started.md", "range": {"start": {"line": 107, "column": 258}}}, "severity": "ERROR"}
* As an alternative, you can also open directly WSL, open your project folder and then opening vscode from there with the command `code .`.

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

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'VSCode' instead of 'vscode'.

Raw Output:
{"message": "[Vale.Terms] Use 'VSCode' instead of 'vscode'.", "location": {"path": "docs/codacy-guardrails/codacy-guardrails-getting-started.md", "range": {"start": {"line": 108, "column": 96}}}, "severity": "ERROR"}
* 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 distro you are using, but for example in Debian and Ubuntu the command will be something like `sudo apt update && sudo apt install curl`.

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

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'distro'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'distro'?", "location": {"path": "docs/codacy-guardrails/codacy-guardrails-getting-started.md", "range": {"start": {"line": 112, "column": 33}}}, "severity": "ERROR"}

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

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'linux'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'linux'?", "location": {"path": "docs/codacy-guardrails/codacy-guardrails-getting-started.md", "range": {"start": {"line": 112, "column": 27}}}, "severity": "ERROR"}
* You can do this directly in WSL or in vscode by going to View > Terminal.

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

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'VSCode' instead of 'vscode'.

Raw Output:
{"message": "[Vale.Terms] Use 'VSCode' instead of 'vscode'.", "location": {"path": "docs/codacy-guardrails/codacy-guardrails-getting-started.md", "range": {"start": {"line": 113, "column": 41}}}, "severity": "ERROR"}

### 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.


## How to install - Manually

Expand Down
Loading