The Sonar Runner is recommended as the default launcher to analyze a project with Sonar.
A sonar-project.properties file must be created in the root directory of the project:
Then the command 'sonar-runner' must be executed from the project base directory to launch the Sonar analysis. That's it!
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:
The property 'project.settings' can be used to specify the path to the project configuration file (this option is incompatible with the 'project.home' property). Ex:
The Sonar working directory can be set through the 'sonar.working.directory' property (default is '.sonar').
The root folder of the project to analyze can be set through the 'project.home' property. This folder must contain a sonar-project.properties file if the mandatory properties (like 'sonar.projectKey') are not specified on the command line.
Additional analysis 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.