For the complete documentation index, see llms.txt. This page is also available as Markdown.
Developer

Vortex for Cursor

How to install Vortex for Cursor using the SonarQube plugin or the SonarQube CLI.

You have two ways to install Vortex for Cursor:

  • Using the Cursor SonarQube plugin

  • Using the SonarQube CLI

Once installed, both options result in exactly the same thing, as the plugin installs the SonarQube CLI for you and automates the integration in the agent. We recommend that individual developers use the SonarQube plugin, and teams or organizations use the CLI directly for automated deployments.

Installing Vortex for Cursor using the SonarQube plugin

Step 1: Install the SonarQube plugin for Cursor

The SonarQube plugin is published in the sonar marketplace catalog on the Cursor marketplace, sourced from the SonarSource/sonarqube-agent-plugins repository.

In Cursor's chat, install the plugin:

/add-plugin sonarqube

You can also install it from Cursor's marketplace panel. For more details, see Cursor.

Step 2: Run the integration skill

After installing the plugin, finish setup by running the guided integration skill:

/sonar-integrate

The skill installs or updates the SonarQube CLI, authenticates it, and asks you to choose a scope. Select Global (all projects) so the integration applies across every project on your machine, matching the CLI installation below. The skill then runs sonar integrate to set up Vortex context and Vortex analysis.

Step 3: Restart your agent

If your agent is running, restart it so the integration is loaded for the current project.

Step 4: Verify your setup

Verify the setup: ask your agent "What is the current architecture of the project? Limit the answer to the top-level blocks."

Installing Vortex for Cursor using the SonarQube CLI

Step 1: Install the SonarQube CLI

Step 2: Run the integration command

Install the integration once, globally, so it applies across every project on your machine:

The CLI asks you questions. Answer "yes" when asked "Install Vortex?" This installs Vortex context and Vortex analysis.

Check your version with sonar --version. With SonarQube CLI versions earlier than 1.8.0 (see the release notes), Vortex only works at project scope. Run the command from the root of your project's repository instead, and pass your project key:

Step 3: Restart your agent

If your agent is running, restart it so the integration is loaded.

Step 4: Verify your setup

Verify the setup: ask your agent "What is the current architecture of the project? Limit the answer to the top-level blocks."

Last updated

Was this helpful?