Skip to content

Commit 06f8a6c

Browse files
add more notes
1 parent a18d196 commit 06f8a6c

2 files changed

Lines changed: 55 additions & 19 deletions

File tree

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Getting Started
2+
3+
Codacy Guardrails is a brand new way of enforcing code security and quality standards for AI-generated code, built into the free Codacy IDE Extension for VSCode, Copilot, Cursor, and Windsurf. Guardrails helps developers ship safer, cleaner AI code by applying best practices and blocking insecure patterns – while the code is being generated.
4+
5+
Besides real-time AI code scanning, Guardrails users can now prompt all their Codacy findings, without ever leaving the AI chat panel inside their IDE.
6+
New to Codacy Guardrails? [Watch the Guardrails live demo](https://youtu.be/uVyRWnnJu-0?feature=shared), or [download the free Codacy Extension] and try it out yourself!
7+
8+
[Check our blog post](https://blog.codacy.com/codacy-guardrails-free-real-time-enforcement-of-security-and-quality-standards)
9+
10+
## Compatibility / Requirements
11+
12+
### Supported Operating Systems
13+
14+
- MACOs
15+
- Linux
16+
- Windows (soon)
17+
18+
### Supported IDE's
19+
20+
- Visual Studio Code
21+
- Cursor
22+
- Windsurf
23+
24+
### Supported tools
25+
26+
- ESLint v9
27+
- Trivy
28+
- Pylint v3
29+
- PMD v6
30+
- Dartanalyzer
31+
- Semgrep
32+
33+
## How to install the Codacy Extension
34+
[IDE extension]: https://www.codacy.com/ide-extension
35+
36+
### Visual Studio Code
37+
[Click here](https://tinyurl.com/codacy-vscode)
38+
39+
### Cursor
40+
[Click here](http://tinyurl.com/codacy-cursor)
41+
42+
### Windsurf
43+
[Click here](http://tinyurl.com/codacy-windsurf)
44+
45+
Once the IDE Extension is installed, follow the steps below:
46+
- Click the Codacy tab (Codacy icon)
47+
- Log in or create your Codacy account (5-second signup via GitHub, Bitbucket, and GitLab)
48+
- Activate the Codacy CLI for local analysis
49+
- Install MCP Server
50+
- Restart the IDE
51+
52+
## How to install MCP Server
53+
[Instructions](https://github.com/codacy/codacy-mcp-server/blob/master/README.md)
54+
[NPM package](https://www.npmjs.com/package/@codacy/codacy-mcp)
55+
[Install CLI](https://github.com/codacy/codacy-cli-v2/blob/main/README.md)

docs/codacy-guardrails/codacy-guardrails-overview.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

0 commit comments

Comments
 (0)