SonarQube Server

https://docs.sonarsource.com/sonarqube-server/2025.1/
Admin
SonarQube Server is an on-premises automated code review and static analysis tool designed to detect...
Tokens:221,904
Snippets:3,207
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Start SonarQube container for JDBC driver installation

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/setup-and-upgrade/install-the-server/installing-sonarqube-from-docker.md

Use this command to initialize the extensions volume for adding an Oracle JDBC driver.

```bash
$ docker run --rm \
    -p 9000:9000 \
    -v sonarqube_extensions:/opt/sonarqube/extensions \
    <image_name>
```

--------------------------------

### Wildcard Pattern Examples

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/project-administration/analysis-scope.md

Examples demonstrating how specific wildcard patterns match or exclude file paths.

```text
**/*.css
```

```text
**/*Bean.java
```

```text
**/*Bean?.java
```

```text
org/sonar/*
```

```text
org/sonar/**/*
```

--------------------------------

### Enable and start the SonarQube service

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/setup-and-upgrade/operating-the-server.md

Commands to enable and start the configured systemd service.

```bash
sudo systemctl enable sonarqube.service
sudo systemctl start sonarqube.service
```

--------------------------------

### Install dotnet-coverage tool

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/analyzing-source-code/test-coverage/dotnet-test-coverage.md

Installs the dotnet-coverage tool globally for use in the build process.

```bash
dotnet tool install --global dotnet-coverage
```

--------------------------------

### Start SonarQube Server from Zip

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/try-out-sonarqube.md

Commands to start the SonarQube server on Windows or Unix-based systems after unzipping the distribution.

```bash
# On Windows, execute:
C:\sonarqube\bin\windows-x86-64\StartSonar.bat
 
# On other operating systems, as a non-root user execute:
/opt/sonarqube/bin/<OS>/sonar.sh console
```

--------------------------------

### Install dotCover tool

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/analyzing-source-code/test-coverage/dotnet-test-coverage.md

Installs the JetBrains dotCover command-line tools globally.

```bash
dotnet tool install --global JetBrains.dotCover.CommandLineTools
```

--------------------------------

### GET /sonarqube-server/2025.1/setup-and-upgrade/pre-installation.md

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/setup-and-upgrade/pre-installation.md

Queries the documentation for specific information using natural language.

```APIDOC
## GET /sonarqube-server/2025.1/setup-and-upgrade/pre-installation.md

### Description
Perform a query against the documentation to retrieve answers, excerpts, or context related to pre-installation steps.

### Method
GET

### Endpoint
https://docs.sonarsource.com/sonarqube-server/2025.1/setup-and-upgrade/pre-installation.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

--------------------------------

### GET /sonarqube-server/2025.1/setup-and-upgrade/deploy-on-kubernetes/server/introduction.md

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/setup-and-upgrade/deploy-on-kubernetes/server/introduction.md

Performs a query against the documentation to retrieve answers and relevant excerpts.

```APIDOC
## GET /sonarqube-server/2025.1/setup-and-upgrade/deploy-on-kubernetes/server/introduction.md

### Description
Queries the documentation for specific information using a natural language question.

### Method
GET

### Endpoint
/sonarqube-server/2025.1/setup-and-upgrade/deploy-on-kubernetes/server/introduction.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### GET /instance-administration/authentication/saml/scim/scim-provisioning-with-azure-ad.md

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/instance-administration/authentication/saml/scim/scim-provisioning-with-azure-ad.md

Queries the documentation dynamically by providing a question and an optional goal.

```APIDOC
## GET /instance-administration/authentication/saml/scim/scim-provisioning-with-azure-ad.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically for information not explicitly present in the page.

### Method
GET

### Endpoint
https://docs.sonarsource.com/sonarqube-server/2025.1/instance-administration/authentication/saml/scim/scim-provisioning-with-azure-ad.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### Install SonarScanner for .NET via Global Tool

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/analyzing-source-code/dotnet-environments/getting-started-with-net.md

Use the .NET CLI to install the SonarScanner as a global tool for .NET Core 3.1 and later.

```bash
dotnet tool install --global dotnet-sonarscanner --version x.x.x
```

--------------------------------

### Install SonarQube Server via Helm

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/setup-and-upgrade/deploy-on-kubernetes/dce/installing-from-helm-repo.md

Adds the SonarQube Helm repository, creates a namespace, and installs the SonarQube DCE chart with a configured JWT secret.

```bash
helm repo add sonarqube https://SonarSource.github.io/helm-chart-sonarqube

helm repo update

kubectl create namespace sonarqube-dce

export JWT_SECRET=$(echo -n "your_secret" | openssl dgst -sha256 -hmac "your_key" -binary | base64)

helm upgrade --install -n sonarqube-dce sonarqube-dce --set applicationNodes.jwtSecret=$JWT_SECRET sonarqube/sonarqube-dce
```

--------------------------------

### GET /sonarqube-server/2025.1/devops-platform-integration/github-integration/introduction.md

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/devops-platform-integration/github-integration/introduction.md

Queries the documentation dynamically by asking a question related to the content.

```APIDOC
## GET /sonarqube-server/2025.1/devops-platform-integration/github-integration/introduction.md

### Description
Perform a query against the documentation to retrieve answers, excerpts, or sources related to a specific question.

### Method
GET

### Endpoint
https://docs.sonarsource.com/sonarqube-server/2025.1/devops-platform-integration/github-integration/introduction.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### GET /setup-and-upgrade/install-the-server/installing-sonarqube-from-docker.md

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/setup-and-upgrade/install-the-server/installing-sonarqube-from-docker.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /setup-and-upgrade/install-the-server/installing-sonarqube-from-docker.md

### Description
Performs a dynamic query against the documentation to retrieve answers and relevant excerpts based on a provided question.

### Method
GET

### Endpoint
https://docs.sonarsource.com/sonarqube-server/2025.1/setup-and-upgrade/install-the-server/installing-sonarqube-from-docker.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Execute GET measures request

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/extension-guide/web-api.md

Example of a cURL command to retrieve project measures using an authorization token.

```bash
curl --request GET \
  --url 'https://sonarqube.com/api/measures/component?metricKeys=ncloc%2Ccode_smells%2Ccomplexity&component=<myProjectKey>' \
  --header 'Authorization: Bearer <myToken>'
```

--------------------------------

### Configure Jest Coverage in GitHub Actions

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/analyzing-source-code/test-coverage/javascript-typescript-test-coverage.md

Example steps for installing dependencies and running Jest with coverage in a CI environment.

```yml
- name: Install dependencies
   run: yarn
- name: Test and coverage
   run: yarn jest --coverage
```

--------------------------------

### GET /setup-and-upgrade/pre-installation/linux.md

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/setup-and-upgrade/pre-installation/linux.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /setup-and-upgrade/pre-installation/linux.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.sonarsource.com/sonarqube-server/2025.1/setup-and-upgrade/pre-installation/linux.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Other Scanner Scripted and Declarative Pipeline Analysis

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/analyzing-source-code/ci-integration/jenkins-integration/add-analysis-to-job.md

Examples for using a custom scanner installation in both scripted and declarative Jenkins pipelines.

```groovy
node {
  stage('SonarQube analysis') {
    def scannerHome = tool '<sonarqubeScannerInstallation>'; // must match the name of an actual scanner installation directory on your Jenkins build agent
    withSonarQubeEnv('<sonarqubeInstallation>') { // If you have configured more than one global server connection, you can specify its name as configured in Jenkins
      sh "${scannerHome}/bin/sonar-scanner"
    }
  }
}
```

```groovy
pipeline {
  agent any
  stages {
    stage('SonarQube analysis') {
      steps {
        script {
            scannerHome = tool '<sonarqubeScannerInstallation>'// must match the name of an actual scanner installation directory on your Jenkins build agent
        }
        withSonarQubeEnv('<sonarqubeInstallation>') {// If you have configured more than one global server connection, you can specify its name as configured in Jenkins
          sh "${scannerHome}/bin/sonar-scanner"
        }
      }
    }
  }
} 
```

--------------------------------

### GET /instance-administration/authentication/gitlab/setting-up.md

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/instance-administration/authentication/gitlab/setting-up.md

Queries the documentation page dynamically to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /instance-administration/authentication/gitlab/setting-up.md

### Description
Perform a query against the documentation page to receive a direct answer, relevant excerpts, and source references.

### Method
GET

### Endpoint
https://docs.sonarsource.com/sonarqube-server/2025.1/instance-administration/authentication/gitlab/setting-up.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /setup-and-upgrade/deploy-on-kubernetes/setting-up-autoscaling.md

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/setup-and-upgrade/deploy-on-kubernetes/setting-up-autoscaling.md

Queries the documentation dynamically by sending a natural language question to the GitBook documentation platform.

```APIDOC
## GET /setup-and-upgrade/deploy-on-kubernetes/setting-up-autoscaling.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, or sources related to a specific question.

### Method
GET

### Endpoint
https://docs.sonarsource.com/sonarqube-server/2025.1/setup-and-upgrade/deploy-on-kubernetes/setting-up-autoscaling.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /sonarqube-server/2025.1/instance-administration/authentication/saml/how-to-set-up-okta.md

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/instance-administration/authentication/saml/how-to-set-up-okta.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /sonarqube-server/2025.1/instance-administration/authentication/saml/how-to-set-up-okta.md

### Description
Perform a query against the documentation to retrieve answers and relevant excerpts based on a natural language question.

### Method
GET

### Endpoint
https://docs.sonarsource.com/sonarqube-server/2025.1/instance-administration/authentication/saml/how-to-set-up-okta.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Start SonarQube service

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/setup-and-upgrade/operating-the-server.md

Command to start the SonarQube service after registration.

```shell
sudo service sonar start
```

--------------------------------

### GET /instance-administration/authentication/saml/how-to-set-up-keycloak.md

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/instance-administration/authentication/saml/how-to-set-up-keycloak.md

Queries the documentation page dynamically to retrieve answers, excerpts, or context based on a specific question and optional goal.

```APIDOC
## GET /instance-administration/authentication/saml/how-to-set-up-keycloak.md

### Description
Queries the documentation dynamically to retrieve information not explicitly present in the page or to get clarification.

### Method
GET

### Endpoint
https://docs.sonarsource.com/sonarqube-server/2025.1/instance-administration/authentication/saml/how-to-set-up-keycloak.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /devops-platform-integration/github-integration/setting-up-at-global-level/setting-up-github-app.md

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/devops-platform-integration/github-integration/setting-up-at-global-level/setting-up-github-app.md

Queries the documentation page dynamically to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /devops-platform-integration/github-integration/setting-up-at-global-level/setting-up-github-app.md

### Description
Perform a query against the documentation page to receive a direct answer and relevant excerpts based on a natural language question.

### Method
GET

### Endpoint
https://docs.sonarsource.com/sonarqube-server/2025.1/devops-platform-integration/github-integration/setting-up-at-global-level/setting-up-github-app.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Verify SonarScanner installation

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/analyzing-source-code/scanners/sonarscanner.md

Commands to verify the installation and display help information for the scanner.

```shellscript
sonar-scanner -h
```

```shellscript
sonar-scanner.bat -h
```

--------------------------------

### GET /devops-platform-integration/gitlab-integration/setting-up-at-project-level.md

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/devops-platform-integration/gitlab-integration/setting-up-at-project-level.md

Queries the documentation dynamically by providing a specific question and an optional goal to receive a tailored answer with relevant excerpts.

```APIDOC
## GET /devops-platform-integration/gitlab-integration/setting-up-at-project-level.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.sonarsource.com/sonarqube-server/2025.1/devops-platform-integration/gitlab-integration/setting-up-at-project-level.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /setup-and-upgrade/installation-requirements/server-host.md

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/setup-and-upgrade/installation-requirements/server-host.md

Performs a dynamic query against the documentation page to retrieve information based on a specific question and optional goal.

```APIDOC
## GET /setup-and-upgrade/installation-requirements/server-host.md

### Description
Queries the documentation dynamically to retrieve information not explicitly present on the page. This allows for context-aware answers based on a specific question and an optional end goal.

### Method
GET

### Endpoint
https://docs.sonarsource.com/sonarqube-server/2025.1/setup-and-upgrade/installation-requirements/server-host.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the answer to the user's needs.
```

--------------------------------

### Install SonarScanner for NPM

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/analyzing-source-code/scanners/npm/installing.md

Commands to add the scanner to project dependencies or install it globally.

```bash
npm install -D @sonar/scan
```

```bash
npm install -g @sonar/scan
```

--------------------------------

### Compliant Title Examples

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/extension-guide/adding-coding-rules.md

Examples of rule titles that adhere to the recommended naming patterns.

```text
* Files should not have too many lines of code
* "System.(out/err)" should not be used to log messages
* Overriding virtual functions should not change parameter defaults
```

--------------------------------

### Noncompliant Title Examples

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/extension-guide/adding-coding-rules.md

Examples of rule titles that do not follow the required naming conventions.

```text
* A file should not have too many lines of code // Noncompliant; singular form used
* Avoid files with too many lines of code // Noncompliant; doesn’t follow "x should [not] y" pattern
* Too many lines of code // Noncompliant
* Don’t use "System.(out/err)" // Noncompliant
* Parameters in an overriding virtual function should either use the same default arguments as the function they override, or not specify any default arguments // Noncompliant; much too long
```

--------------------------------

### Free Format COBOL Example

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/analyzing-source-code/languages/cobol.md

Example of COBOL source code structured in free format.

```css-79elbk
Area1 | Area2
      * MY COMMENT
       IDENTIFICATION DIVISION.
         PROGRAM-ID. HELLOWORLD.
       PROCEDURE DIVISION.
         DISPLAY "HELLO COBOL !" LINE 42 POSITION 12.
         STOP RUN.
```

--------------------------------

### GET /instance-administration/authentication/saml/ping-identity/setup-in-sq.md

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/instance-administration/authentication/saml/ping-identity/setup-in-sq.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /instance-administration/authentication/saml/ping-identity/setup-in-sq.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.sonarsource.com/sonarqube-server/2025.1/instance-administration/authentication/saml/ping-identity/setup-in-sq.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /sonarqube-server/2025.1/server-update-and-maintenance/troubleshooting/creating-support-ticket.md

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/server-update-and-maintenance/troubleshooting/creating-support-ticket.md

Perform an HTTP GET request to query the documentation dynamically for specific information.

```APIDOC
## GET /sonarqube-server/2025.1/server-update-and-maintenance/troubleshooting/creating-support-ticket.md

### Description
Queries the documentation dynamically by providing a specific question and an optional goal to receive a tailored answer with relevant excerpts.

### Method
GET

### Endpoint
https://docs.sonarsource.com/sonarqube-server/2025.1/server-update-and-maintenance/troubleshooting/creating-support-ticket.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate, specific question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /sonarqube-server/2025.1/setup-and-upgrade/deploy-on-kubernetes/dce/introduction.md

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/setup-and-upgrade/deploy-on-kubernetes/dce/introduction.md

Queries the documentation for information by providing a specific question and an optional end goal.

```APIDOC
## GET /sonarqube-server/2025.1/setup-and-upgrade/deploy-on-kubernetes/dce/introduction.md

### Description
Queries the documentation dynamically to retrieve answers to specific questions based on the provided content.

### Method
GET

### Endpoint
https://docs.sonarsource.com/sonarqube-server/2025.1/setup-and-upgrade/deploy-on-kubernetes/dce/introduction.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### Install SonarScanner for Python via pip

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/analyzing-source-code/scanners/sonarscanner-for-python.md

Use this command to install the pysonar package in your Python environment.

```bash
pip install pysonar
```

--------------------------------

### GET /sonarqube-server/2025.1/user-guide/managing-your-account/introduction.md

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/user-guide/managing-your-account/introduction.md

Queries the documentation dynamically by asking a question related to the current page content.

```APIDOC
## GET /sonarqube-server/2025.1/user-guide/managing-your-account/introduction.md

### Description
Queries the documentation dynamically by providing a specific question and an optional goal to receive a tailored answer with relevant excerpts.

### Method
GET

### Endpoint
https://docs.sonarsource.com/sonarqube-server/2025.1/user-guide/managing-your-account/introduction.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### Install Coverlet Global Tool

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/analyzing-source-code/test-coverage/dotnet-test-coverage.md

Install the Coverlet console tool globally before running coverage analysis.

```bash
dotnet tool install --global coverlet.console
```

--------------------------------

### Neutralizing code examples

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/extension-guide/adding-coding-rules.md

Avoid using real-world company URLs in rule examples to maintain neutrality.

```css-79elbk
$fp = file_get_contents("https://www.real-company.com"); 
```

```css-79elbk
$fp = file_get_contents("https//www.example.com");
// or even better:
$fp = file_get_contents("https://localhost");
```

--------------------------------

### Analyze C# and C++ with SonarScanner for .NET

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/analyzing-source-code/languages/c-family/running-the-analysis.md

Example commands for beginning, building, and ending analysis for a mixed-language project.

```bash
SonarScanner.MSBuild.exe begin /k:"cs-and-cpp-project-key" /n:"My C# and C++ project" /v:"1.0" /d:sonar.cfamily.compile-commands="build_wrapper_output_directory/compile_commands.json"
build-wrapper-win-x86-64.exe --out-dir build_wrapper_output_directory MSBuild.exe /t:Rebuild /nodeReuse:False
SonarScanner.MSBuild.exe end
```

--------------------------------

### Generic Test Execution Report Example

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/analyzing-source-code/test-coverage/generic-test-data.md

An example XML structure for a generic test execution report.

```xml
<testExecutions version="1">
  <file path="testx/ClassOneTest.xoo">
    <testCase name="test1" duration="5"/>
    <testCase name="test2" duration="500">
      <skipped/>
    </testCase>
    <testCase name="test3" duration="100">
      <failure/>
    </testCase>
    <testCase name="test4" duration="500">
      <error/>
    </testCase>
  </file>
</testExecutions>
```

--------------------------------

### Generic Test Coverage Report Example

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/analyzing-source-code/test-coverage/generic-test-data.md

An example XML structure for a generic test coverage report.

```xml
<coverage version="1">
  <file path="xources/hello/NoConditions.xoo">
    <lineToCover lineNumber="6" covered="true"/>
    <lineToCover lineNumber="7" covered="false"/>
  </file>
  <file path="xources/hello/WithConditions.xoo">
    <lineToCover lineNumber="3" covered="true" branchesToCover="2" coveredBranches="1"/>
  </file>
</coverage>
```

--------------------------------

### GET /sonarqube-server/2025.1/devops-platform-integration/github-integration/setting-up-at-global-level.md

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/devops-platform-integration/github-integration/setting-up-at-global-level.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /sonarqube-server/2025.1/devops-platform-integration/github-integration/setting-up-at-global-level.md

### Description
Queries the documentation dynamically to retrieve answers and relevant excerpts based on a provided question.

### Method
GET

### Endpoint
https://docs.sonarsource.com/sonarqube-server/2025.1/devops-platform-integration/github-integration/setting-up-at-global-level.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### Install SonarQube Server via Helm

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/setup-and-upgrade/deploy-on-kubernetes/server/installing-helm-chart.md

Standard commands to add the SonarQube repository, update local indices, and deploy the chart to a Kubernetes namespace.

```bash
helm repo add sonarqube https://SonarSource.github.io/helm-chart-sonarqube
helm repo update
kubectl create namespace sonarqube # If you dont have permissions to create the namespace, skip this step and replace all -n with an existing namespace name.
helm upgrade --install -n sonarqube sonarqube sonarqube/sonarqube
```

--------------------------------

### GET /sonarqube-server/2025.1/setup-and-upgrade/install-the-server/advanced-installation-features.md

Source: https://docs.sonarsource.com/sonarqube-server/2025.1/setup-and-upgrade/install-the-server/advanced-installation-features.md

Queries the documentation dynamically to retrieve answers, excerpts, or context related to the documentation content.

```APIDOC
## GET https://docs.sonarsource.com/sonarqube-server/2025.1/setup-and-upgrade/install-the-server/advanced-installation-features.md

### Description
Queries the documentation dynamically by providing a specific question and an optional end goal to receive a tailored answer with relevant excerpts.

### Method
GET

### Endpoint
https://docs.sonarsource.com/sonarqube-server/2025.1/setup-and-upgrade/install-the-server/advanced-installation-features.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```
Tokens:
Raw