Vortex for GitHub Copilot CLI

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

You have two ways to install Vortex for GitHub Copilot CLI:

• Using the GitHub Copilot CLI 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 GitHub Copilot CLI using the SonarQube plugin

Step 1: Install the SonarQube plugin for GitHub Copilot CLI

Install the SonarQube plugin from the awesome-copilot marketplace, which is registered by default in GitHub Copilot CLI:

• From your shell, run copilot plugin install sonarqube@awesome-copilot.
• Or inside an interactive Copilot CLI session, run /plugin install sonarqube@awesome-copilot.

For more details, see GitHub Copilot CLI.

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 runs sonar integrate to set up context augmentation and agentic analysis for the current project.

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 GitHub Copilot CLI using the SonarQube CLI

Step 1: Install the SonarQube CLI

Install the SonarQube CLI and authenticate.

Step 2: Integrate your project

Run the following command at the root of your project's repository:

sonar integrate copilot --project <your_project_key>

The CLI asks you questions. Answer "yes" when asked if you want "Context Augmentation" and "Agentic 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."