The SonarScanner is the scanner to use when there is no specific scanner for your build system.
- Expand the downloaded file into the directory of your choice. We'll refer to it as
$install_directoryin the next steps.
Update the global settings to point to your SonarQube server by editing
#----- Default SonarQube server #sonar.host.url=http://localhost:9000
- Add the
$install_directory/bindirectory to your path.
Verify your installation by opening a new shell and executing the command
sonar-scanner.bat -hon Windows). You should get 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 output
If you need more debug information you can add one of the following to your command line:
Create a configuration file in the root directory of the project:
# must be unique in a given SonarQube instance sonar.projectKey=my:project # --- 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-8
Run the following command from the project base directory to launch the analysis:
Alternatives to sonar-project.properties
If a 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. Ex:
sonar-scanner -Dsonar.projectKey=myproject -Dsonar.sources=src1
The property project.settings can 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 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.
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. E.G. analysis begins from
jenkins/jobs/myjob/workspace but the files to be analyzed are in
This is configured in
sonar-project.properties as follows:
sonar.projectBaseDir=/home/ftpdrop/cobol/project1 sonar.sources=src sonar.cobol.copy.directories=/copy
More parameters can be configured, see Analysis Parameters for details.
Java heap space error or java.lang.OutOfMemoryError
Increase the memory via the
SONAR_SCANNER_OPTS environment variable:
On 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 Scanner for MSBuild. If you are running Scanner for MSBuild, ensure that you are not hitting a known limitation.