Installation

The steps you need to install SonarQube for VS Code in your IDE.

For the most part, SonarQube for IDE can be installed directly from your IDE’s Marketplace. Offline installations are also possible and previous versions are available if needed.

Instructions

SonarQube for VS Code can be installed like any other VS Code extension as explained in the VS Code documentation. The standard installation workflow described below works for VS Code, including the Cursor and Trae editors, as well as VSCodium, GitHub Codespaces, and GitPod, among others:

1. Select Extensions in the left sidebar of your VS Code app.

2. Enter SonarQube for IDE in the search bar.

3. Select Install.

Once the installation is complete, select the Reload Required button to finish the process.

Using the standard method, SonarQube for VS Code will be downloaded from:

• the Microsoft Visual Studio Marketplace for VSCode and GitHub Codespaces.

• the OpenVSX community marketplace, for Cursor, Trae, and Windsurf editors, as well as VSCodium and GitPod.

  • Both Cursor and Windsurf offer profile migration tools, which should include your VS Code extensions.

  • In Cursor, you can simply drag and drop the .vsix file into the extensions tab.

As an alternative, the VSIX package for any given version can be downloaded from the /sonarlint-vscode Release page on GitHub and installed using the Install from VSIX command in accordance with Microsoft’s Install from a VSIX instructions.

First taste of SonarQube for IDE

Now that you have SonarQube for VS Code installed, open or create a new project containing source files in a programming language SonarQube for VS Code can analyze out of the box. See the Rules and languages for languages that work with your IDE.

SonarQube for VS Code offers a walkthrough to help you make the best out of it SonarQube for IDE; it covers the basic features to help you:

• see issues in your code.

• learn more about those issues and fix them.

• synchronize the analysis configuration with other contributors.

• diagnose problems and share feedback with the SonarQube for IDE team.

The walkthrough will be automatically displayed when you install SonarQube for IDE for the first time, and you can manually open it anytime from the command palette: search Welcome Open Walkthrough…, then select Welcome to SonarQube for IDE! to have a look!

Connect to your server

Connect SonarQube for VS Code to your instance of SonarQube Server, SonarQube Cloud, or SonarQube Community Build to expand your analysis capabilities and share quality profiles with your team. See the article about connected mode Benefits, and the Connected mode setup page for full instructions to get going.

Updating SonarQube for IDE in VS Code

By default, SonarQube for VS Code will update automatically as soon as a new release is published. However, SonarQube for VS Code will not update automatically for users who intentionally pin a previous version of the extension.

Limitations

SonarQube for VS Code is not supported in Visual Studio Code Virtual Workspaces. When installing SonarQube for VS Code you may receive the following error: This extension has been disabled because it does not support virtual workspaces

Support for virtual workspaces is on the Sonar roadmap; please check out the feature description and tell us how important the feature is to you.