NameSonarQube Runner
Latest version2.4 ( 28 Apr 2014 )
Requires SonarQube version3.7 or higher
LicenseGNU LGPL 3
DevelopersJulien Henry
Issue tracker


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



  1. Uncompress the downloaded file into the directory of your choice. We'll refer to it as <install_directory> in the next steps.
  2. Update the global settings (database connection, server URL) by editing <install_directory>/conf/

    #----- Default SonarQube server
    #----- PostgreSQL
    #----- MySQL
    #----- Oracle
    #----- Microsoft SQLServer
    #----- Global database settings



  3. Create a new SONAR_RUNNER_HOME environment variable set to <install_directory>.
  4. Add the <install_directory>/bin directory to your path.
  5. You can check the basic installation by opening a new shell and executing the command sonar-runner -h (on Windows platform the command is sonar-runner.bat -h) . You should get a message like this:

    usage: sonar-runner [options]
     -D,--define <arg>     Define property
     -e,--errors           Produce execution error messages
     -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 the sonar.verbose property by adding the command line parameter -Dsonar.verbose=true.

You are now ready to analyze a project with the SonarQube Runner.