The Sonar Runner is recommended as the default launcher to analyze a project with Sonar.

Prerequisite

You must have previously installed the Sonar Runner and read Analyzing Code Source.

Usage

For each project a file sonar-project.properties must be created in the root directory of the project. This project configuration file must contain all properties required by Sonar to analyze the project:

Then the command 'sonar-runner' or 'sonar-runner.bat' (windows) must be executed from the project base directory to launch the Sonar analysis. That's it!

If a sonar-project.properties file can't be created in the root directory of the project, there are two alternatives:

• Either properties can be specified directly through the command line. Ex: 'sonar-runner -Dsonar.projectKey=myproject -Dsources=src1 ...'
• Or the property 'project.settings' can be used to specify the path to the project configuration file. Ex:  'sonar-runner -Dproject.settings=../myproject.properties'.

For advanced features such as reusing existing unit test reports, any Sonar advanced parameters can be defined in this project configuration file or through command-line parameters. 

If you get an java.lang.OutOfMemoryError, you can set the SONAR_RUNNER_OPTS environment variable, like this in *nix environments: On Windows environments, avoid the double-quotes, since they get misinterpreted, turning the two parameters into a single one.

Sample Project

See Sonar Project Examples.

Advanced Properties

Here are some advanced optional properties that can be used for the Sonar Runner: