SonarScanner CLI
When your build system lacks a dedicated scanner, the SonarScanner CLI is the go-to tool for initiating an analysis with SonarQube Cloud.
The SonarScanner CLI is the scanner to use when there is no specific scanner for your build system. It supports ARM architecture for macOS and Linux.
Installation
Expand the downloaded file into the directory of your choice. We’ll refer to it as
$install_directoryin the next step.Add the
$install_directory/bindirectory to your path.Verify your installation by opening a new shell and executing the command
sonar-scanner -h(sonar-scanner.bat -hon Windows). You should get an output like this:
usage: sonar-scanner [options]
Options:
-D,--define <arg> Define property
-h,--help Display help information
-v,--version Display version information
-X,--debug Produce execution debug outputIf you need more debug information you can add one of the following to your command line:
-X, --verbose, or -Dsonar.verbose=true.
Use
Create a configuration file in the root directory of the project:
sonar-project.properties
# Organization and project keys are displayed in the right sidebar of the project homepage
sonar.organization=my_organization
sonar.projectKey=my_project
sonar.host.url=https://sonarcloud.io
# --- optional properties ---
# defaults to project key
#sonar.projectName=My project
# defaults to 'not provided'
#sonar.projectVersion=1.0
# Path is relative to the sonar-project.properties file. Defaults to .
#sonar.sources=.
# Encoding of the source code. Default is default system encoding
#sonar.sourceEncoding=UTF-8Set the environment variable
SONAR_TOKENwith the Scoped Organization Token (SOT) (recommended from the Team plan) or Personal Access Token (PAT). Note that the token can also be set through the command line argument-Dsonar.token. To generate the token, see Managing Scoped Organization Tokens or Managing Personal Access Tokens.Run the command
sonar-scanner, orsonar-scanner.baton Windows, from the project base directory to run the analysis.
sample-projects
To help you get started, simple project samples are available for most languages on GitHub. They can be browsed or downloaded.
Alternatives to the sonar-project.properties file
If the sonar-project.properties file cannot be created in the root directory of the project, the alternatives are:
The properties can be specified directly through the command line. Example:
sonar-scanner -Dsonar.organization=my_organization -Dsonar.projectKey=my_project -Dsonar.sources=srcThe property
project.settingscan be used to specify the path to the project configuration file (this option is incompatible with thesonar.projectBaseDir.property).The root folder of the project to analyze can be set through the
sonar.projectBaseDirproperty. This folder must contain asonar-project.propertiesfile if thesonar.projectKeyis not specified on the command line. Additional analysis parameters can be defined in this project configuration file or through command line parameters.
Alternate analysis directory
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. For example, when an analysis begins from jenkins/jobs/myjob/workspace but the files to be analyzed are in ftpdrop/cobol/project1.
sonar.projectBaseDir=/home/ftpdrop/cobol/project1
sonar.sources=src
sonar.cobol.copy.directories=/copyFor more, see the listing of Analysis parameters.
Troubleshooting
Java heap space error or java.lang.OutOfMemoryError
Increase the memory using SONAR_SCANNER_JAVA_OPTS environment variable for SonarScanner CLI version 6.0 and higher. For the previous versions use SONAR_SCANNER_OPTS:
export SONAR_SCANNER_JAVA_OPTS="-Xmx512m"In Windows environments, avoid using double-quotes, since they get misinterpreted, with the result that the two parameters are combined into a single one.
set SONAR_SCANNER_JAVA_OPTS=-Xmx512m"java" cannot be opened because the developer cannot be verified
The SonarScanner CLI is not yet Apple verified therefore, when using the macOS AArch64 version, you may get an OS security window displaying this message. A solution us to run:
sudo xattr -dr com.apple.quarantine /path/to/sonar-scanner-version-macosx-aarch64Note that the SonarScanner does not yet officially support ARM architecture. Still, early adopters reported it is working fine. If you encounter other problems when running the scanner on ARM architecture, don’t hesitate to share your experience with us on the SonarQube Server or SonarQube Cloud Community Forum but keep in mind that there is no support at this time.
Unsupported major.minor version
Install the last version of SonarScanner CLI (from version 6.0, no JRE installation is required). Otherwise, upgrade the version of Java being used for analysis or use one of the native package (that embed its own Java runtime).
Property sonar.cs.analyzer.projectOutPaths is missing
No protobuf files will be loaded for this project. SonarScanner is not able to analyze .NET projects. Please use the SonarScanner for .NET.
Last updated
Was this helpful?