codacy-vscode-extension

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

codacy-vscode-extension

★ 14 Open GitHub ↗

Codacy VisualStudio Code Extension

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Codacy IDE Extension

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/ce7a0f3329764b348bced84c55334a5d)](https://app.codacy.com?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [![Codacy Badge](https://app.codacy.com/project/badge/Coverage/ce7a0f3329764b348bced84c55334a5d)](https://app.codacy.com?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)

**Code quality, security, and AI Guardrails—all in your editor, all in real-time.**

Transform your IDE into a powerful code quality hub. Get instant feedback on code quality, security, and test coverage as you work. Control AI-generated code with Codacy Guardrails and catch issues early with local analysis—before you even create a pull request. From real-time coverage visualization to automated PR analysis, everything you need for better code is now at your fingertips.

## 🚀 Features

- **Automated PR Analysis:**  
  Instantly see code quality and security issues introduced by your pull requests, right inside your IDE.

- **Issue Browser:** 
 Browse, triage, and fix issues found by Codacy directly in your IDE, with quick fixes and detailed context available for each issue. 
 
 <img src="https://github.com/codacy/codacy-vscode-extension/raw/HEAD/.readme/screenshot-issue-browser.png" alt="Issue Browser"/>
 
 Browse for issues filtered by category and severity.

- **Inline Coverage:** 
 Visualize code coverage as you work, with inline decorations. 
 
 <img src="https://github.com/codacy/codacy-vscode-extension/raw/HEAD/.readme/screenshot-coverage.png" alt="Coverage Decoration"/>
 
 Visualize code coverage inline in the editor.

- **AI Guardrails:** 
 Automatically validate and review AI-generated code for security and quality standards.
 
 <img src="https://github.com/codacy/codacy-vscode-extension/raw/HEAD/.readme/recording-guardrails.gif" alt="AI Guardrails"/>
 
 Get the AI code reviewed immediately after.

- **Local Analysis:** 
 Run Codacy CLI locally for instant feedback (macOS/Linux/WSL).
 
 <img src="https://github.com/codacy/codacy-vscode-extension/raw/HEAD/.readme/screenshot-local-analysis.png" alt="Local Analysis"/>
 
 Browse and fix issues directly in the Problems panel.

- **One-click Actions:**  
  Connect to Codacy, join organizations, and add repositories with a single click.

## 🧭 Getting Started with Codacy

We've designed the extension to guide you smoothly through every step of your journey. Here's what you might see and how we'll help you get started:

### 🔑 Connecting to Codacy
Need to log in? When you see "You are not connected to Codacy", just click 'Connect to Codacy' to unlock all features. It only takes a minute!

### 🏢 Setting Up & Joining Your Organization
Whether you're new to Codacy or joining an existing team, we've got you covered! Here's what you might see:

- **Need to join?** If you see "You are not part of this organization in Codacy", click 'Join organization' to request access to your team.

- **New organization?** If you see "This organization is not part of Codacy", click 'Add organization' to set up code quality analysis for your entire team.

- **Waiting for approval?** After requesting to join, you might see "Your request to join the organization is pending admin approval". Hang tight while your team admin reviews your request!

<img src="https://github.com/codacy/codacy-vscode-extension/raw/HEAD/.readme/screenshot-add-organization.png" alt="Add Organization Prompt"/>
 
 Set up your organization and establish team-wide coding standards.

### 📚 Adding Your Project
Ready to analyze your code? When you see "This repository is not yet added to Codacy", simply click 'Add repository' and we'll start helping you write better code.

 <img src="https://github.com/codacy/codacy-vscode-extension/raw/HEAD/.readme/screenshot-add-repository.png" alt="Add Repository Prompt"/>
 
 Add your repository to Codacy to start analyzing your code.

Once your repository is added, we'll keep you informed about your code analysis.

Don't worry - each step comes with clear guidance and actions to help you move forward. We're here to make your coding experience better!

## 🏁 Getting Started

### Prerequisites
- [Codacy account](https://www.codacy.com/signup-codacy)
- Repository [added to Codacy Cloud](https://docs.codacy.com/organizations/managing-repositories/#adding-a-repository)
- At least [Repository Read permissions](https://docs.codacy.com/organizations/roles-and-permissions-for-organizations/)

### Installation
- Install from within Visual Studio Code (Cmd+Shift+X or Ctrl+Shift+X), or from [the Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=codacy-app.codacy).
- Alternatively, [download the latest version as a VSIX package](https://github.com/codacy/codacy-vscode-extension/releases) and install it manually.

### First Use
- Open your project, connect to Codacy, and start analyzing code.
- For advanced usage, see the [official documentation](https://docs.codacy.com/getting-started/integrating-codacy-with-visual-studio-code/).

## 🛟 Troubleshooting

- Confirm that the repository has been [added to Codacy Cloud](https://docs.codacy.com/organizations/managing-repositories/#adding-a-repository) and that you have at least [Repository Read permissions](https://docs.codacy.com/organizations/roles-and-permissions-for-organizations/).
- **Having issues?** Check the Output panel in your IDE (View > Output > Codacy) for:
  - Detailed error messages and troubleshooting steps
  - Connection and authentication status
  - Analysis progress and results
  - Organization and repository setup information

- If you're having trouble connecting to Codacy in Linux, make sure the protocol of the IDE you're using is registered.

Steps to register IDE protocol:

Run:

```
 nano ~/.local/share/applications/<ide-name>.desktop
 ```

In the file add the following:

```
 [Desktop Entry]
 Name=<ide-name>
 Exec=/path/to/ide/appImage --open-url %U
 Type=Application
 Terminal=false
 MimeType=x-scheme-handler/<ide-name>;
 Icon=utilities-terminal
 Categories=Development;
 ```

Run:

```
  update-desktop-database ~/.local/share/applications/

xdg-mime default <ide-name>.desktop x-scheme-handler/<ide-name>
 ```

## 🤝 Community & Support

- **Need help?** [Open support chat](https://start-chat.com/slack/codacy/kShTS8?utm_source=Company+website&utm_medium=direct)
- **Enjoying the experience?** [Leave a review](https://marketplace.visualstudio.com/items?itemName=codacy-app.codacy&ssr=false#review-details)
- **Want to contribute?** [See our contributing guidelines](https://github.com/codacy/codacy-vscode-extension/blob/main/CONTRIBUTING.md)

## 📚 References

- [Codacy IDE Extension Documentation](https://docs.codacy.com/getting-started/integrating-codacy-with-visual-studio-code/)

codacy-vscode-extension

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

codacy-vscode-extension

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README