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: docusaurus/docs/codacy-guardrails/codacy-guardrails-faq.mdx
+16-22Lines changed: 16 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: FAQs
3
3
---
4
4
5
5
## How do I install Codacy Guardrails?
6
-
Please have a look at our [documentation](codacy-guardrails-getting-started.md).
6
+
Please have a look at our [documentation](./codacy-guardrails-getting-started).
7
7
8
8
## Does Guardrails only work with AI-generated code?
9
9
No. While Guardrails does scan and autofix AI code as part of the agent flow, it scans any code shown in your IDE in real-time, regardless of how it was written.
@@ -49,17 +49,17 @@ Codacy Guardrails is a free IDE Extension for local scanning of AI-generated and
49
49
50
50
Check our [Team and Organization plans](https://www.codacy.com/pricing) to unlock:
51
51
52
-
-Central configuration and enforcement of AI coding standards across teams and projects
53
-
-Query and autofix existing problems across your codebase from the AI chat panel
54
-
-Generate custom security and code quality reports using AI prompts
55
-
-Full access to the Codacy Cloud platform including:
52
+
- Central configuration and enforcement of AI coding standards across teams and projects
53
+
- Query and autofix existing problems across your codebase from the AI chat panel
54
+
- Generate custom security and code quality reports using AI prompts
55
+
- Full access to the Codacy Cloud platform including:
56
56
57
-
- Pipeline-less AppSec and code quality scans
58
-
- PR merge gates
59
-
- Team dashboards
60
-
- Security reports
61
-
- DAST pipelines
62
-
- Jira integration
57
+
- Pipeline-less AppSec and code quality scans
58
+
- PR merge gates
59
+
- Team dashboards
60
+
- Security reports
61
+
- DAST pipelines
62
+
- Jira integration
63
63
64
64
## Does Guardrails work with all OS?
65
65
Guardrails is supported on MacOS, Linux, and Windows (via [WSL](https://learn.microsoft.com/en-us/windows/wsl/install))
@@ -74,18 +74,12 @@ Without an AI coding agent, you can still use the IDE extension for local analys
74
74
If you wish to continue using a previous version a little longer, you can do so by:
75
75
76
76
1. Open the Extensions tab
77
-
78
-
2. Select `Codacy`
79
-
80
-
3. Click on the down arrow on the right of the Uninstall button
81
-
82
-
4. Select `Install specific version...`
83
-
77
+
1. Select `Codacy`
78
+
1. Click on the down arrow on the right of the Uninstall button
79
+
1. Select `Install specific version...`
84
80
85
-
86
-
5. Select the version you want on the top search bar
87
-
88
-
6. Click on `Restart Extensions` when that button appears
81
+
1. Select the version you want on the top search bar
82
+
1. Click on `Restart Extensions` when that button appears
89
83
90
84
Keep in mind that the IDE extension is under active development, so be sure to check for updates regularly.
91
85
To revert to the latest version, click on `Update`.
## How to install - Quick Guide {#how-to-install-quick-guide}
55
+
## How to install - Quick Guide \{#how-to-install-quick-guide\}
56
56
57
57
#### Note for Windows users:
58
58
To take advantage of Codacy Guardrails on Windows, you might need to setup WSL first, [check the steps here.](#how-to-install-wsl)
@@ -109,7 +109,7 @@ You can later generate the instructions manually from the Guardrails section of
109
109
* 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.
110
110
* 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.
111
111
112
-
## How to install - WSL {#how-to-install-wsl}
112
+
## How to install - WSL \{#how-to-install-wsl\}
113
113
114
114
### 1. Install or update [WSL.](https://learn.microsoft.com/en-us/windows/wsl/install)
115
115
@@ -120,7 +120,7 @@ You can later generate the instructions manually from the Guardrails section of
120
120
121
121
## How to install - Manually
122
122
123
-
### 1. Install and activate the Codacy CLI for local analysis {#install-cli}
123
+
### 1. Install and activate the Codacy CLI for local analysis \{#install-cli\}
124
124
125
125
#### Download
126
126
@@ -153,7 +153,7 @@ Before running the analysis, install the specified tools:
153
153
codacy-cli install
154
154
```
155
155
156
-
### 2. Install MCP Server {#install-mcp-server}
156
+
### 2. Install MCP Server \{#install-mcp-server\}
157
157
158
158
If you want to use MCP Server with a NPM package you should download it from [here](https://www.npmjs.com/package/@codacy/codacy-mcp)
159
159
@@ -220,7 +220,7 @@ Or open the general settings.json file directly, which according to your OS shou
220
220
221
221
222
222
223
-
Make sure you update the value of `CODACY_ACCOUNT_TOKEN` with your [API token](../codacy-api/api-tokens.md).
223
+
Make sure you update the value of `CODACY_ACCOUNT_TOKEN` with your [API token](../codacy-api/api-tokens).
224
224
225
225
a. Above the MCP Server configuration in **Settings.json** file, you can Click in the command **Start**
226
226
@@ -269,7 +269,7 @@ For JetBrains IDEs, IntelliJ isn't the only supported editor, but is our primary
## How to install - JetBrains Quick Guide {#how-to-install-quick-guide-jetbrains}
272
+
## How to install - JetBrains Quick Guide \{#how-to-install-quick-guide-jetbrains\}
273
273
274
274
#### Note for Windows users:
275
275
To take advantage of Codacy Guardrails on Windows, you need to set up WSL first; [check the steps here](#how-to-install-wsl). **Only local analysis** are supported for Windows, as MCP support for JetBrains IDEs is still not completely done.
Copy file name to clipboardExpand all lines: docusaurus/docs/codacy-guardrails/codacy-guardrails-how-to-configure-rules.mdx
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
title: How to customize the analysis rules for Codacy Guardrails
3
3
---
4
4
5
-
By default, if no API token is provided in the [MCP Server setup](codacy-guardrails-getting-started.md/#3-install-mcp-server), Codacy uses a predefined configuration that includes all recommended rules (or [code patterns](../repositories-configure/configuring-code-patterns.md) that you can find on many parts of our product) from the supported built-in scanners.
5
+
By default, if no API token is provided in the [MCP Server setup](codacy-guardrails-getting-started#3-install-mcp-server), Codacy uses a predefined configuration that includes all recommended rules (or [code patterns](../repositories-configure/configuring-code-patterns) that you can find on many parts of our product) from the supported built-in scanners.
6
6
7
7
However, when an API token is used, Codacy automatically retrieves the current rule configuration directly from your repository.
8
8
@@ -67,13 +67,13 @@ The table below lists the configuration file names that Codacy detects and suppo
67
67
68
68
To use a configuration file for a static analysis tool:
69
69
70
-
1. Make sure the configuration file is located in the root of the [default Codacy branch](../repositories-configure/managing-branches.mdx).
70
+
1. Make sure the configuration file is located in the root of the [default Codacy branch](../repositories-configure/managing-branches).
71
71
72
72
2. Open the repository **Code patterns** page, select the tool of interest, and activate the toggle to use a configuration file.
73
73
74
74
:::note
75
-
- After activating a configuration file for a tool, Codacy uses that configuration file even if you [exclude it from Codacy analysis](../repositories-configure/ignoring-files.md).
76
-
- When [using a tool configuration file alongside a coding standard](../organizations/using-coding-standards.md#using-with-tool-configuration), the configuration file controls the code patterns, while the coding standard controls whether the tool is enabled or disabled.
75
+
- After activating a configuration file for a tool, Codacy uses that configuration file even if you [exclude it from Codacy analysis](../repositories-configure/ignoring-files).
76
+
- When [using a tool configuration file alongside a coding standard](../organizations/using-coding-standards#using-with-tool-configuration), the configuration file controls the code patterns, while the coding standard controls whether the tool is enabled or disabled.
77
77
- Codacy uses the version of the configuration file **in the branch being analyzed**. For example, if you open a pull request that includes changes to the configuration file, the analysis results take those changes into account.
78
78
- If Codacy analyzes a branch that doesn't include the configuration file, Codacy reverts to using the code patterns configured for the tool before you selected the option **Configuration file** on the Code patterns page.
79
79
- For performance reasons, when you update pattern settings using a configuration file, Codacy may display outdated messages for issues identified previously by those patterns.
@@ -88,8 +88,8 @@ To use a configuration file for a static analysis tool:
88
88
89
89
If you want to use Codacy UI, there are two ways you can follow to configure the built-in scanner rules:
90
90
91
-
- Using the [Code Patterns](../repositories-configure/configuring-code-patterns.md) configuration, if you want to configure the rules per repository or
92
-
- Using [Coding Standards](../organizations/using-coding-standards.md), if you want to configure the rules for multiple repositories
91
+
- Using the [Code Patterns](../repositories-configure/configuring-code-patterns) configuration, if you want to configure the rules per repository or
92
+
- Using [Coding Standards](../organizations/using-coding-standards), if you want to configure the rules for multiple repositories
93
93
94
94
### Code Patterns
95
95
@@ -106,7 +106,7 @@ In order to set up your rules, please follow the next steps:
3. Select a tool to enable or disable its code patterns. To make it easier to find relevant patterns, use the filters above the pattern list. You can filter by [issue category](../faq/code-analysis/which-metrics-does-codacy-calculate.md#issues), status, severity level, or display only recommended code patterns.
109
+
3. Select a tool to enable or disable its code patterns. To make it easier to find relevant patterns, use the filters above the pattern list. You can filter by [issue category](../faq/code-analysis/which-metrics-does-codacy-calculate#issues), status, severity level, or display only recommended code patterns.
110
110
111
111
To see an explanation of the issues that a pattern detects and how to fix them, click the respective dropdown arrow.
112
112
@@ -122,7 +122,7 @@ In order to set up your rules, please follow the next steps:
122
122
123
123
Coding standards enable the analysis of multiple repositories with the same scanner and rules configurations, ensuring consistent code quality across your organization. Multiple coding standards can be applied to the same repository. For example, you can use coding standards to ensure that a group of repositories follow the same security rules or coding conventions.
124
124
125
-
To apply or edit a repository's [coding standards](../organizations/using-coding-standards.md), click **Customize** in the **Following ...** section at the top of the **Code patterns** page.
125
+
To apply or edit a repository's [coding standards](../organizations/using-coding-standards), click **Customize** in the **Following ...** section at the top of the **Code patterns** page.
0 commit comments