sonarsource/sonar-scanner-cli repository overview

⁠SonarScanner CLI Docker Image

SonarScanner⁠ is the official command-line tool for running code analysis on SonarQube and SonarCloud. This image is provided by SonarSource and packages the SonarScanner CLI.

NB: These Docker images are not compatible with C# and Objective-C projects. For C&C++, the docker images are only compatible with AutoConfig mode⁠.

• Source repository of this image: https://github.com/SonarSource/sonar-scanner-cli-docker⁠
• Source repository of the SonarScanner CLI: https://github.com/SonarSource/sonar-scanner-cli⁠

⁠Changelog

Version 10 has introduced a significant change that could potentially affect some users. In this version, the underlying SonarScanner CLI process is executed with a regular user (uid 1000), instead of the root user. You may encounter permission issues on your volumes or bind mounts.

⁠Versioning

Starting with version 10, the image version is distinct from the embedded SonarScanner CLI version. The tag format is: x.y.z.buildNumber_ScannerCLIVersion. Please note that the latest tag always refers to the most recent release, which may include breaking changes. To mitigate potential impacts, consider using a specific version if you prefer more control. If you wish to access the latest patch of a specific version, you can use tags that point to major or major.minor releases, such as 10 or 10.0.

⁠How to use this image

To scan using the latest SonarScanner CLI Docker image, use the command:

docker run \
--rm \
-e SONAR_HOST_URL="https://${SONAR_HOST_URL}"  \
-v "${PROJECT_BASEDIR}:/usr/src" \
sonarsource/sonar-scanner-cli

where:

• ${SONAR_HOST_URL} is the URL of your SonarQube instance or https://sonarcloud.io/⁠ if you want to scan on SonarCloud
• ${PROJECT_BASEDIR} is the location of the source code you want to scan

For information on how to use and configure the image, head over to the Docker section of SonarScanner CLI docs⁠.

⁠Questions or Feedback

For support questions ("How do I?", "I got this error, why?", ...), please first read the documentation⁠ and then head to the SonarSource forum⁠. There are chances that a question similar to yours has already been answered.

Be aware that this forum is a community, so the standard pleasantries ("Hi", "Thanks", ...) are expected. And if you don't get an answer to your thread, you should sit on your hands for at least three days before bumping it. Operators are not standing by. :-)

⁠Contributing

If you would like to see a new feature, please create a new thread in the community forum⁠ (“Product Manager of the Day”)

⁠License

Copyright 2015-2024 SonarSource.

Licensed under the GNU Lesser General Public License, Version 3.0⁠