> For the complete documentation index, see [llms.txt](https://docs.sonarsource.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sonarsource.com/agent-centric-development-cycle/inside-your-agent-the-agentic-loop/how-to-guides/install-vortex-copilot.md).

# Vortex for GitHub Copilot 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](/agent-centric-development-cycle/developer-tools/agent-plugins/github-copilot-cli.md).

### 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](/agent-centric-development-cycle/inside-your-agent-the-agentic-loop/how-to-guides/check-vortex-setup.md): 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](/sonarqube-cli/quickstart-guide.md) and [authenticate](/sonarqube-cli/quickstart-guide.md#step-2-authenticate).

### Step 2: Integrate your project

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

```bash
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](/agent-centric-development-cycle/inside-your-agent-the-agentic-loop/how-to-guides/check-vortex-setup.md): ask your agent *"What is the current architecture of the project? Limit the answer to the top-level blocks."*


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.sonarsource.com/agent-centric-development-cycle/inside-your-agent-the-agentic-loop/how-to-guides/install-vortex-copilot.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.