The SonarScanner CLI is the scanner to use when there is no specific scanner for your build system. The SonarScanner CLI does not support ARM architecture.
Create a configuration file in your project's root directory called
To run SonarScanner CLI from the zip file, follow these steps:
- Expand the downloaded file into the directory of your choice. We'll refer to it as
<INSTALL_DIRECTORY>in the next steps.
- Update the global settings to point to your SonarQube server by editing
#----- Default SonarQube server
- Add the
<INSTALL_DIRECTORY>/bindirectory to your path.
- Verify your installation by opening a new shell and executing the command
sonar-scanner -h, or
sonar-scanner.bat -hon Windows. You should get an output like this:
usage: sonar-scanner [options]
-D,--define <arg> Define property
-h,--help Display help information
-v,--version Display version information
-X,--debug Produce execution debug output
If you need more debug information, you can add one of the following to your command line:
- Run the following command from the project base directory to launch analysis and pass your authentication token:
Alternatively, instead of passing the token in your command line, you can create the
SONAR_TOKENenvironment variable and set the token as its value before you launch the analysis.
To scan using the SonarScanner CLI Docker image, use the following command:
Scanning projects that contain C, C++, or Objective-C code requires some additional analysis steps. You can find full details on the C/C++/Objective-C language page.
sonar-project.properties file cannot be created in the root directory of the project, there are several alternatives:
- The properties can be specified directly through the command line. Example:
sonar-scanner -Dsonar.projectKey=myproject -Dsonar.sources=src1
- The property
project.settingscan be used to specify the path to the project configuration file (this option is incompatible with the
- The root folder of the project to analyze can be set through the
sonar.projectBaseDirproperty since SonarScanner CLI 2.4. This folder must contain a
sonar.projectKeyis not specified on the command line. Additional analysis parameters can be defined in this project configuration file or through command-line parameters.
If the files to be analyzed are not in the directory where the analysis starts from, use the
sonar.projectBaseDir property to move analysis to a different directory. E.g. analysis begins from
jenkins/jobs/myjob/workspace but the files to be analyzed are in
ftpdrop/cobol/project1. This is configured in
sonar-project.properties as follows:
You can configure more parameters. See Analysis parameters for details.
If your SonarQube server is configured with HTTPS and a self-signed certificate then you must install the self-signed certificate into the Java truststore of your CI/CD host machine otherwise the scanner will not be able to connect to the server and the analysis will fail.
The following sections offer advanced configuration options when running the SonarScanner CLI with Docker. Click the headings to expand the instructions.
Running as a non-root user
You can run the Docker image as a non-root user using the
--user option. For example, to run as the current user:
When running the container as a non-root user you have to make sure the user has read and write access to the directories you are mounting (like your source code or scanner cache directory), otherwise you may encounter permission-related problems.
Caching scanner files
To prevent SonarScanner CLI from re-downloading language analyzers each time you run a scan, you can mount a directory where the scanner stores the downloads so that the downloads are reused between scanner runs. On some CI systems, you also need to add this directory to your CI cache configuration.
The following command will store and use cache between runs:
You can also change the location of where the scanner puts the downloads with the
SONAR_USER_HOME environment variable.
Java heap space error or java.lang.OutOfMemoryError
Increase the memory via the
SONAR_SCANNER_OPTS environment variable when running the scanner from a zip file:
In Windows environments, avoid the double quotes, since they get misinterpreted, and combine the two parameters into a single one.
Unsupported major.minor version
Upgrade the version of Java being used for analysis or use one of the native package (that embed its own Java runtime).
Property missing: 'sonar.cs.analyzer.projectOutPaths'. No protobuf files will be loaded for this project.
Scanner CLI is not able to analyze .NET projects. Please, use the SonarScanner for .NET. If you are running the SonarScanner for .NET, ensure that you are not hitting a known limitation.