@sonar/scan makes it very easy to trigger SonarQube Server and Cloud analyses on a JavaScript code base, without needing to install any specific tool or (Java) runtime.

This module is analyzed on SonarQube Cloud.

This is the documentation for v4. If you are using v3, refer to the v3 documentation.

Prerequisite: Node v18+ (for v4 and above)

Prerequisite: Node v16+ (for v3, otherwise use sonarqube-scanner v2.9.1)

This package is available on npm as: @sonar/scan

To install the scanner globally and be able to run analyses on the command line:

npm install -g @sonar/scan

If you want to run an analysis without having to configure anything in the first place, simply run the sonar command. The following example assumes that you have installed SonarQube Server locally:

cd my-project
sonar

or you can use npx without installing:

cd my-project
npx @sonar/scan

For the extended information, please refer to its documentation.

@sonar/scan is licensed under the LGPL v3 License.