Skip to content

Commit 89a78a5

Browse files
improve docs!
1 parent 444fae0 commit 89a78a5

2 files changed

Lines changed: 22 additions & 13 deletions

File tree

docs/codacy-guardrails/codacy-guardrails-faq.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,17 @@ Yes, local scanning via Codacy CLI works offline. API-based features (like query
1212
## What sort of security and quality standards can I enforce with Codacy Guardrails?
1313
Codacy Guardrails detects and auto-remediates security risks and quality issues in JavaScript, TypeScript, Python, and Java, including:
1414

15-
SAST vulnerabilities
16-
Hardcoded secrets
17-
Insecure dependencies
18-
Error prone code
19-
Performance issues
20-
Best practices
21-
Complex code
22-
Code duplications
23-
Styling violations
15+
16+
- SAST vulnerabilities
17+
- Hardcoded secrets
18+
- Insecure dependencies
19+
- Error prone code
20+
- Performance issues
21+
- Best practices
22+
- Complex code
23+
- Code duplications
24+
- Styling violations
25+
2426
Configuring and enforcing coding standards at scale across all IDEs in your organization requires a Codacy Team or Business subscription.
2527

2628
## Is my data secure?

docs/codacy-guardrails/codacy-guardrails-getting-started.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,17 @@ Click on the button **Install** below Codacy icon
5454

5555
### 2. Activate the Codacy CLI for local analysis
5656

57-
Click on the button **Install Codacy CLI**
57+
#### VSCode
58+
59+
Click on the button **Install Codacy CLI** (only for VSCode)
5860

5961
![Install CLI](images/codacy-extension-activate-cli.png)
6062

63+
#### Other IDEs
64+
65+
[Click here](#install-cli)
66+
67+
6168
It will create a folder in your local repository called **.codacy** with the app already installed
6269

6370
### 3. Install MCP Server
@@ -70,7 +77,7 @@ Click on the button **Add Codacy MCP Server**
7077

7178
#### a. Add the Codacy MCP Server - Other IDEs
7279

73-
[Click here](#3-install-mcp-server)
80+
[Click here](#install-mcp-server)
7481

7582
#### b. Check if the Codacy MCP Server is enabled
7683

@@ -85,7 +92,7 @@ It should be all **green** without any **error message**
8592

8693
### 1. [Download the extension](#download-extension)
8794

88-
### 2. Install and activate Codacy CLI for local analysis
95+
### 2. Install and activate Codacy CLI for local analysis {: id="install-cli"}
8996

9097
#### Download
9198

@@ -118,7 +125,7 @@ Before running the analysis, install the specified tools:
118125
codacy-cli install
119126
```
120127

121-
### 3. Install MCP Server
128+
### 3. Install MCP Server {: id="install-mcp-server"}
122129

123130
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)
124131

0 commit comments

Comments
 (0)