# Connected mode Connecting SonarQube for IDE to [SonarQube Server](https://app.gitbook.com/o/2ibCvzwZt86Nlk2zloB7/s/LWhbesChsC4Yd1BbhHhS/), [SonarQube Cloud](https://app.gitbook.com/o/2ibCvzwZt86Nlk2zloB7/s/B4UT2GNiZKjtxFtcFAL7/), or [SonarQube Community Build](https://app.gitbook.com/o/2ibCvzwZt86Nlk2zloB7/s/bqrfLGeD0Y9vE5l9Le42/) is the first step in setting up the Sonar Solution, to take advantage of having consistent issues reported on both sides. Setting up connected mode will permit the transmission of information SonarQube for IDE needs, such as URLs and user credentials or file exclusions and marked issues, to communicate with SonarQube (Server, Cloud) or SonarQube Community Build. When binding your local workspace folder to your SonarQube (Server, Cloud) or SonarQube Community Build project(s), SonarQube for IDE will try to match, as much as possible, the same rules and settings as found on the server. While in connected mode, SonarQube for IDE receives notifications from SonarQube (Server, Cloud) or SonarQube Community Build about your quality gate changes and new issues. Smart notifications can be enabled or disabled from the UI while creating or editing the connection settings. ## **Benefits** * Analyze more *languages* and detect more *issues* by combining rules in the IDE with those supported by SonarQube (Server, Cloud), or Sonarqube Community Build. * See [rules](https://docs.sonarsource.com/sonarqube-for-vs-code/using/rules "mention") in SonarQube for VS Code * See [Supported languages](https://app.gitbook.com/s/LWhbesChsC4Yd1BbhHhS/analyzing-source-code/languages/overview "mention") in SonarQube Server * See [Supported languages](https://app.gitbook.com/s/B4UT2GNiZKjtxFtcFAL7/discovering-sonarcloud/overview "mention") in SonarQube Cloud * See [Supported languages](https://app.gitbook.com/s/bqrfLGeD0Y9vE5l9Le42/analyzing-source-code/languages/overview "mention") in SonarQube Community Build * Highlight advanced issues (in the IDE) like [taint-vulnerabilities](https://docs.sonarsource.com/sonarqube-for-vs-code/using/taint-vulnerabilities "mention"), detected by SonarQube Server and SonarQube Cloud. * An issue discovered in SonarQube (Server, Cloud) or SonarQube Community Build can be quickly explored in the IDE via a dedicated button. See the [#opening-issues-in-the-ide](https://docs.sonarsource.com/sonarqube-for-vs-code/using/investigating-issues#opening-issues-in-the-ide "mention") article for details. * Use the same *quality profile* locally as is defined by SonarQube (Server, Cloud), or SonarQube Community Build. * See the [Managing quality profiles](https://app.gitbook.com/s/LWhbesChsC4Yd1BbhHhS/quality-standards-administration/managing-quality-profiles "mention") pages in SonarQube Server. * See the [Managing quality profiles](https://app.gitbook.com/s/B4UT2GNiZKjtxFtcFAL7/standards/managing-quality-profiles "mention") pages in SonarQube Cloud. * Apply settings, such as [#rule-selection](https://docs.sonarsource.com/sonarqube-for-vs-code/using/rules#rule-selection "mention") and [file-exclusions](https://docs.sonarsource.com/sonarqube-for-vs-code/using/file-exclusions "mention") defined on the server to your local analysis. * Define specific *analyzer parameters* on the server and have those parameters applied locally. * See the [Analysis parameters](https://app.gitbook.com/s/LWhbesChsC4Yd1BbhHhS/analyzing-source-code/analysis-parameters "mention") page in SonarQube Server. * See the [Analysis parameters](https://app.gitbook.com/s/B4UT2GNiZKjtxFtcFAL7/analyzing-source-code/analysis-parameters "mention") page in SonarQube Cloud. * See the [Analysis parameters](https://app.gitbook.com/s/bqrfLGeD0Y9vE5l9Le42/analyzing-source-code/analysis-parameters "mention") page in SonarQube Community Build. * Automatically suppress issues that are marked as **Accepted** or **False Positive** on the server. See the [#marking-issues](https://docs.sonarsource.com/sonarqube-for-vs-code/using/fixing-issues#marking-issues "mention") article to understand how this works locally. {% hint style="info" %} When running in connected mode with SonarQube Server 10.4 or newer, **Won’t Fix** becomes **Accept**. {% endhint %} * Use the SonarQube for VS Code **Focus on new code** feature to concentrate the detection of issues only in new code, as you defined in SonarQube (Server, Cloud), or SonarQube Community Build. * See the [#focusing-on-new-code](https://docs.sonarsource.com/sonarqube-for-vs-code/using/investigating-issues#focusing-on-new-code "mention") article * Check the page on [new-code](https://docs.sonarsource.com/sonarqube-for-vs-code/using/new-code "mention") for information about how it affects quality standards locally and on the server. * When you accept [#notifications](#notifications "mention") in your IDE, changes made to your quality gates on the server arrive in your IDE. * See the [Quality standards administration](https://app.gitbook.com/s/LWhbesChsC4Yd1BbhHhS/quality-standards-administration "mention") pages in SonarQube Server * See the [Setting your quality standards](https://app.gitbook.com/s/B4UT2GNiZKjtxFtcFAL7/standards "mention") pages in SonarQube Cloud. {% hint style="info" %} Connected mode does not push issues to the server. Rather, its purpose is to configure the IDE so that it uses the same settings, as much as possible, as it is defined on the server. {% endhint %} [Free and open-source](https://www.sonarsource.com/open-source-editions/) versions of [SonarQube Community Build](https://www.sonarsource.com/products/sonarqube/downloads/) and [SonarQube Cloud](https://www.sonarsource.com/products/sonarcloud/signup/) are available to work in connected mode. In [SonarQube Cloud](https://www.sonarsource.com/products/sonarcloud/), it’s always free to analyze your publicly accessible projects; if you want to link to a private repository, see the instructions found on SonarQube Cloud's [Subscription plans](https://app.gitbook.com/s/B4UT2GNiZKjtxFtcFAL7/administering-sonarcloud/managing-subscription/subscription-plans "mention") page. ## Prerequisites and supported languages To run SonarQube for VS Code in connected mode, you must have a SonarQube Server project in an active version (see the [Release cycle model](https://app.gitbook.com/s/LWhbesChsC4Yd1BbhHhS/server-update-and-maintenance/update/release-cycle-model "mention") page) or a SonarQube Cloud project. In addition to the published languages on the [rules](https://docs.sonarsource.com/sonarqube-for-vs-code/using/rules "mention"), you can unlock Apex rules, COBOL rules, PL/SQL rules, and T-SQL rules when using connected mode with SonarQube Server and SonarQube Cloud. ## Branch awareness Branch awareness allows SonarQube for IDE to consider the branch currently checked out in the IDE and synchronize it with the most appropriate branch from the SonarQube (Server, Cloud) or SonarQube Community Build; we call this *branch matching*. In connected mode, SonarQube for IDE synchronizes some data from the issues found on the server, such as the issue’s status and resolution. It is important that SonarQube for IDE knows which branch the user is on at that moment to sync the local analysis with the correct branch analyzed by SonarQube (Server, Cloud) or SonarQube Community Build. The use of Git is required for SonarQube for VS Code to find the best match between the local branch and the branch analyzed by SonarQube (Server, Cloud) or SonarQube Community Build. SonarQube for VS Code shows the name of the branch used to reference issues synchronized in the IDE’s status bar. In the picture below, the checked-out git branch is named "current\_branch", and the analyzed branch on the SonarQube Server is named "branch\_to\_analyze".
SonarQube for VS Code will display the name of the matched analyzed branch on the server.
### Checking which branches are analyzed on the server In SonarQube Server, open the highlighted drop-down list shown below (as it looks in SonarQube Server) for a list of analyzed branches and pull requests.
A view of your analyzed branches and pull request in SonarQube Server.
To analyze branches other than `master`|`main` , please check these pages on branch analysis: * The [Branch analysis](https://app.gitbook.com/s/LWhbesChsC4Yd1BbhHhS/analyzing-source-code/branch-analysis "mention") pages in SonarQube Server. * The [Branch analysis](https://app.gitbook.com/s/B4UT2GNiZKjtxFtcFAL7/analyzing-source-code/branch-analysis/branch-analysis "mention") page in SonarQube Cloud. ### How SonarQube for IDE selects which branch to sync SonarQube for IDE deploys these three methods to choose which branch (in SonarQube (Server, Cloud)) to sync with the local analysis. **Exact match** Branches with the same name are considered the same branch. If the branch that is currently checked out locally is analyzed on the server, SonarQube for IDE will pick this branch for synchronization. **Closest branch** SonarQube for IDE will consider all local branches that also exist on the server. For each branch, SonarQube for IDE will compute the distance between the current `HEAD` and the branch by the count of commits. The closest branch will be kept. In case the number of commits is the same for two or more branches and the main branch is among them, the main branch will be preferred; otherwise, the tie will be broken with a random choice (from the list of equidistant branches). **Default to main branch** All other cases will default to the branch marked as "main" on the server. For example, if there is an error in reading the branch, or if there is no Git repo, SonarQube for IDE will default to the main branch. **Long and short-lived branches** When using Connected Mode with SonarQube Cloud, issues on short-lived branches are not synchronized. When an issue is marked in SonarQube Cloud *accepted* or *false positive* on a short-lived branch, SonarQube for IDE will still show that issue in the IDE. SonarQube Server does not distinguish between long- and short-lived branches therefore, all issue resolutions are recognized. ### PR analysis synchronization Currently, this feature does not support synchronization with pull request analysis. ## Connection setup SonarQube for VS Code provides a connection wizard to help you set up connected mode with SonarQube (Server, Cloud) or SonarQube Community Build. Please see the [setup](https://docs.sonarsource.com/sonarqube-for-vs-code/connect-your-ide/setup "mention") page for detailed instructions to set up connected mode and bind your project. ### Sharing your setup It’s possible to share a setup configuration file with your team, simplifying the process. One team member must step through the first-time setup process, and then export and commit the binding configuration to the repository. Any team member running SonarQube for IDE will find the binding details inside the project’s source folder and automatically receive a notification to bind the project. Please see the [#first-time-connection-setup-for-shared-binding](https://docs.sonarsource.com/sonarqube-for-vs-code/setup#first-time-connection-setup-for-shared-binding "mention") article for detailed instructions. ## Known limits Some features do not work when running in connected mode. Here are the reasons why: **Open in IDE** When running SonarQube for IDE in connected mode with SonarQube Server 10.3 and above, SonarQube Cloud, or SonarQube Community Build, the **Open in IDE** feature is available (see [#opening-issues-in-the-ide](https://docs.sonarsource.com/sonarqube-for-vs-code/using/investigating-issues#opening-issues-in-the-ide "mention")). *This feature relies on local communication between your web browser and SonarQube for VS Code* therefore, is not available in some remote environments such as GitPod, or GitHub CodeSpaces. **Jupyter notebooks** When working with Jupyter Notebooks, connected mode will be ignored. You will only have local analysis. This is because SonarQube (Server, Cloud) or SonarQube Community Build does not yet support the analysis of Jupyter Notebooks. / ## SonarQube for IDE-SonarQube Server version support policy SonarQube for IDE enables users to establish a connection to the latest SonarQube Server version and to the latest LTA (Long-Term Active) version. When a new LTA version is released, we still enable connecting SonarQube for IDE to the previous LTA version for a certain period of time (currently 9 months after the latest LTA release) to allow enough time for organizations to update their SonarQube Server version. {% hint style="warning" %} *The 8.9LTA reached its support expiration date (in November ’23)*. {% endhint %} For more information about long-term support of SonarQube Server, check out our page describing SonarQube Server's [Release cycle model](https://app.gitbook.com/s/LWhbesChsC4Yd1BbhHhS/server-update-and-maintenance/update/release-cycle-model "mention"). Review your SonarQube for IDE-specific requirements for version-to-version differences. ## Notifications Connected mode allows SonarQube (Server, Cloud) and SonarQube Community Build to send smart alerts to individuals or teams as soon as something appears on the server that something failed, when new issues are discovered or when the Sonar Quality Profile is updated, for example. With everyone in the loop, issues can be addressed promptly, improving the overall software quality and delivery. The notification will include a link to call back to SonarQube (Server, Cloud) and SonarQube Community Build where you can learn more about the issues that were introduced. You’ll receive smart notifications in your IDE when: * the quality gate status of a project you have *open in your IDE* changes. See these pages on managing quality gates: * [Managing quality gates](https://app.gitbook.com/s/LWhbesChsC4Yd1BbhHhS/quality-standards-administration/managing-quality-gates "mention") in SonarQube Server * [Managing quality gates](https://app.gitbook.com/s/B4UT2GNiZKjtxFtcFAL7/standards/managing-quality-gates "mention") in SonarQube Cloud * a SonarQube (Server, Cloud) and SonarQube Community Build analysis raises new issues *that you’ve introduced in a project open in your IDE* You can activate or deactivate smart notifications in SonarQube for IDE on the IDE side for a server-by-server basis. Sonar Smart Notifications are available in all editions of SonarQube (Server, Cloud) and SonarQube Community Build.