Skip to content

doc: Add FAQ for installing a different guardrails IDE extension version #2426

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 6 commits into from
Jul 21, 2025
Merged

doc: Add FAQ for installing a different guardrails IDE extension version #2426

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e560ebc
doc: Add FAQ for installing a different guardrails IDE extension version
nfcodacy Jul 11, 2025
13a8c13
Merge branch 'master' into update/downgradeExtension
nfcodacy Jul 16, 2025
178abc2
Update docs/codacy-guardrails/codacy-guardrails-faq.md
nfcodacy Jul 17, 2025
309c18c
Update docs/codacy-guardrails/codacy-guardrails-faq.md
nfcodacy Jul 21, 2025
3164596
Update docs/codacy-guardrails/codacy-guardrails-faq.md
nfcodacy Jul 21, 2025
62209dd
Update docs/codacy-guardrails/codacy-guardrails-faq.md
nfcodacy Jul 21, 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
17 changes: 15 additions & 2 deletions docs/codacy-guardrails/codacy-guardrails-faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,19 @@
Guardrails is supported on MacOS, Linux, and Windows (via [WSL](https://learn.microsoft.com/en-us/windows/wsl/install))

## Can I use Guardrails without an AI copilot?
Codacy Guardrails is designed to be installed from our IDE extension for VS Code, Cursor and Windsurf. but as long as you have an AI code generator that's compatible with the MCP protocol you can also add Guardrails into your MCP configuration manually.
Codacy Guardrails is designed to be installed from our IDE extension for VS Code, Cursor and Windsurf, but as long as you have an AI code generator that's compatible with the MCP protocol you can also add Guardrails into your MCP configuration manually.

Without an AI coding agent, you instead need to use the Codacy IDE extension without the MCP Server.
Without an AI coding agent, you can still use the IDE extension for local analysis and PR check information.

## How can I install a specific version of the IDE extension?
Comment thread
nfcodacy marked this conversation as resolved.

If you wish to continue using a previous version a little longer, you can do so by:
1. Open the Extensions tab
2. Select `Codacy`
3. Click on the down arrow on the right of the Uninstall button
4. Select `Install specific version...`
![install specific version](images/install-specific-version.png)
5. Select the version you want on the top search bar
6. Click on `Restart Extensions` when that button appears

Keep in mind that the IDE extension is under active development, so be sure to check for updates regularly. Reverting to the latest version is as simple as clicking on **Update**.

Check failure on line 83 in docs/codacy-guardrails/codacy-guardrails-faq.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[alex.Condescending] Using 'simple' may come across as condescending.

Raw Output:
{"message": "[alex.Condescending] Using 'simple' may come across as condescending.", "location": {"path": "docs/codacy-guardrails/codacy-guardrails-faq.md", "range": {"start": {"line": 83, "column": 147}}}, "severity": "ERROR"}

Check warning on line 83 in docs/codacy-guardrails/codacy-guardrails-faq.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Adverbs] Consider removing 'regularly'.

Raw Output:
{"message": "[Microsoft.Adverbs] Consider removing 'regularly'.", "location": {"path": "docs/codacy-guardrails/codacy-guardrails-faq.md", "range": {"start": {"line": 83, "column": 98}}}, "severity": "WARNING"}
Binary file added docs/codacy-guardrails/images/install-specific-version.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading