On this page

Mandatory parametersOptional parameters

Analysis parameters

Project analysis settings can be configured in multiple places. Here is the hierarchy in order of precedence:

Diagram showing settings hierarchy
  1. Global properties: Apply to all projects. Defined in the UI in Administration > Configuration > General Settings
  2. Project properties: Apply to one project only. At project level, defined in the UI in Project Settings > General Settings
  3. Project analysis parameters: Defined in a project analysis configuration file or scanner configuration file
  4. Analysis / Command line parameters: Defined when launching an analysis with -D on the command line

Note that only parameters set through the UI are stored in the database. For example, if you override the sonar.exclusions parameter via command-line for a specific project, it will not be stored in the database. Subsequent analyses, or analyses in SonarLint with connected mode, would still be executed with the exclusions defined in the UI and therefore stored in the DB.

Most of the property keys shown in the interface at both global and project levels can also be set as analysis parameters, but the parameters listed below can only be set at analysis time.

For language-specific parameters related to test coverage and execution, see test coverage. For language-specific parameters related to external issue reports, see external issues.

Mandatory parameters

Server

Project configuration

KeyDescriptionDefault
sonar.projectKeyThe project's unique key. Allowed characters are: letters, numbers, -_. and :, with at least one non-digit.For Maven projects, this defaults to <groupId>:<artifactId>

Optional parameters

Project identity

KeyDescriptionDefault
sonar.projectNameName of the project that will be displayed on the web interface.<name> for Maven projects, otherwise project key. If not provided and there is already a name in the DB, it won't be overwritten.
sonar.projectVersionThe project version.<version> for Maven projects, otherwise "not provided". Do not use your build number as sonar.projectVersion.

Authentication

By default, user authentication is required to prevent anonymous users from browsing and analyzing projects on your instance, and you need to authenticate when running analyses. Authentication is enforced in the global Security settings.

When authentication is required or the "Anyone" pseudo-group does not have permission to perform analyses, you'll need to supply the credentials of a user with Execute Analysis permissions for the analysis to run under.

KeyDescription
sonar.loginThe authentication token of a SonarQube user with either Execute Analysis permission on the project or Global Execute Analysis permission.

Web services

KeyDescriptionDefault
sonar.ws.timeoutMaximum time to wait for the response of a Web Service call (in seconds). Modifying this value from the default is useful only when you're experiencing timeouts during analysis while waiting for the server to respond to Web Service calls.60

Project configuration

KeyDescriptionDefault
sonar.projectDescriptionThe project description.<description> for Maven projects
sonar.links.homepageProject home page.<url> for Maven projects
sonar.links.ciContinuous integration.<ciManagement><url> for Maven projects
sonar.links.issueIssue tracker.<issueManagement><url> for Maven projects
sonar.links.scmProject source repository.<scm><url> for Maven projects
sonar.sourcesComma-separated paths to directories containing main source files.Read from build system for Maven, Gradle, MSBuild projects. Defaults to project base directory when neither sonar.sources nor sonar.tests is provided.
sonar.testsComma-separated paths to directories containing test source files.Read from build system for Maven, Gradle, MSBuild projects. Else default to empty.
sonar.sourceEncodingEncoding of the source files. Ex: UTF-8MacRomanShift_JIS. This property can be replaced by the standard property project.build.sourceEncoding in Maven projects. The list of available encodings depends on your JVM.System encoding
sonar.externalIssuesReportPathsComma-delimited list of paths to Generic Issue reports.
sonar.externalIssuesReportPathsComma-delimited list of paths to SARIF reports.
sonar.projectDate

Assign a date to the analysis. This parameter is only useful when you need to retroactively create the history of a not-analyzed-before project. The format is YYYY-MM-DD, for example, 2010-12-01. Since you cannot perform an analysis dated prior to the most recent one in the database, you must analyze and recreate your project history in chronological order, the oldest first.  

exclamation icon

Note: You may need to adjust your housekeeping settings if you wish to create a long-running history.

Current date
sonar.projectBaseDir

Use this property when you need analysis to take place in a directory other than the one from which it was launched. E.G. analysis begins from jenkins/jobs/myjob/workspace but the files to be analyzed are in ftpdrop/cobol/project1. The path may be relative or absolute. Specify not the source directory, but some parent of the source directory. The value specified here becomes the new "analysis directory", and other paths are then specified as though the analysis were starting from the specified value of sonar.projectBaseDir.

exclamation icon

Note that the analysis process will need write permissions in this directory; it is where the sonar.working.directory will be created.


sonar.working.directorySet the working directory for an analysis triggered with the SonarScanner or the SonarScanner for Ant (versions greater than 2.0). This property is not compatible with the SonarScanner for MSBuild. The path must be relative, and unique for each project.  Beware: the specified folder is deleted before each analysis..scannerwork
sonar.scm.providerThis property can be used to explicitly tell SonarQube which SCM you're using on the project (in case auto-detection doesn't work). The value of this property is always lowercase and depends on the SCM (ex. "git" if you're using Git). Check the SCM integration documentation for more.
sonar.scm.forceReloadAllBy default, blame information is only retrieved for changed files. Set this property to true to load blame information for all files. This can be useful if you feel that some SCM data is outdated but SonarQube does not get the latest information from the SCM engine.
sonar.scm.exclusions.disabledFor supported engines, files ignored by the SCM, i.e. files listed in .gitignore, will automatically be ignored by analysis too. Set this property to true to disable that feature. SCM exclusions are always disabled if sonar.scm.disabled is set to true.
sonar.scm.revisionOverrides the revision, for instance the Git sha1, displayed in analysis results. By default value is provided by the CI environment or guessed by the checked-out sources.
sonar.buildString

The string passed with this property will be stored with the analysis and available in the results of api/project_analyses/search, thus allowing you to later identify a specific analysis and obtain its ID for use with api/project_analyses/set_baseline.



sonar.analysis.[yourKey]This property stub allows you to insert custom key/value pairs into the analysis context, which will also be passed forward to webhooks.
sonar.newCode.referenceBranchSets the new code definition to Reference Branch for this analysis, overriding the configuration on the server. The New Code will be calculated based on the differences between the branch under analysis and the provided branch. This parameter is intended to be set in a configuration file (ex: sonar-project.properties), specific to a given branch.
sonar.filesize.limitSets the limit in MB for files to be discarded from the analysis scope if the size is greater than specified.20

Duplications

KeyDescriptionDefault
sonar.cpd.${language}.minimumTokensA piece of code is considered duplicated as soon as there are at least 100 duplicated tokens in a row (override with sonar.cpd.${language}.minimumTokens) spread across at least 10 lines of code (override with sonar.cpd.${language}.minimumLines). For Java projects, a piece of code is considered duplicated when there is a series of at least 10 statements in a row, regardless of the number of tokens and lines. This threshold cannot be overridden.100
sonar.cpd.${language}.minimumLines(see above)10

Analysis logging

KeyDescriptionDefault
sonar.log.levelControl the quantity/level of logs produced during an analysis. DEBUG: Display INFO logs + more details at DEBUG level. Similar to sonar.verbose=trueTRACE: Display DEBUG logs + the timings of all ElasticSearch queries and Web API calls executed by the SonarScanner.INFO
sonar.verbose

Add more detail to both client and server-side analysis logs. Activates DEBUG mode for the scanner, and adds client-side environment variables and system properties to the server-side log of analysis report processing. 

exclamation icon

NOTE: There is the potential for this setting to expose sensitive information such as passwords if they are stored as server-side environment variables.

false
sonar.scanner.dumpToFileOutputs to the specified file the full list of properties passed to the scanner API as a means to debug analysis.
sonar.scanner.metadataFilePathSet the location where the scanner writes the report-task.txt file containing among other things the ceTaskId.

value of sonar.working.directory





Quality gate

KeyDescriptionDefault
sonar.qualitygate.waitsonar.qualitygate.wait
sonar.qualitygate.timeoutSets the number of seconds that the scanner should wait for a report to be processed.300

Deprecated

KeyDescriptionDefault

sonar.links.scm_dev

cross icon

Deprecated since SQ 7.1

Developer connection.<scm><developerConnection> for Maven projects

© 2008-2022, SonarSource S.A, Switzerland. Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution-NonCommercial 3.0 United States License. SONARQUBE is a trademark of SonarSource SA. All other trademarks and copyrights are the property of their respective owners.

Creative Commons License