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

Sonar Vortex

What your SonarQube Cloud organization needs before your developers can install Sonar Vortex in their coding agents.

Sonar Vortex equips your developers' coding agents to write code that fits your project, and to check that code as it is produced. It has two halves:

  • Guide, which gives an agent your project's context, rules, and constraints before it writes code.

  • Verify, which analyzes the code the agent produces with the precision of a full CI analysis.

Developers reach both halves from their own machine, through the SonarQube CLI, a SonarQube agent plugin, or a locally running SonarQube MCP Server. This page covers what your organization needs in place first. To learn how the two halves work, see Sonar Vortex in the Agent Centric Development Cycle documentation.

Vortex is part of Sonar Agent Essentials, a product that requires a separate subscription to your SonarQube Cloud Enterprise plan or annual Team plan. See Subscription plans.

Because SonarQube Cloud is hosted, there is nothing to deploy and no instance-level setting to turn on. Once your organization has the subscription, your developers can install Vortex in their agents.

Prerequisites

Check these for each project your developers use Vortex on:

  • The project is analyzed in your CI pipeline on a long-lived branch. Vortex analysis reaches CI-level precision by restoring the analyzer context collected during a CI analysis, so a project that has never been analyzed has no context to restore. The context is stored per project and branch.

  • The project uses Architecture analysis, for the best guidance of your developers' agents.

If a Java project is analyzed using Automatic analysis rather than in a CI pipeline, Vortex analysis returns only basic results.

What your developers need from you

What
Value

Your organization key

The key of your SonarQube Cloud organization.

The region URL

https://sonarcloud.io for the EU region, or https://sonarqube.us for the US region.

A personal access token

Each developer generates their own. See Managing personal access tokens. Scoped organization tokens are not supported.

The project key

The key of the project they work on, which Vortex uses to find the stored analyzer context.

For the full instructions, point your developers at Installing Vortex.

Last updated

Was this helpful?