Once you have Node.js
v8.x on your machine, you can use npx
or install sonarwhal
globally
to use it.
Just run the following command:
npx sonarwhal https://example.com
This will start the wizard to create a .sonarwhalrc
file, and then
analyze https://example.com
.
Windows users: Currently npx
has an issue in this
platform.
npm install -g --engine-strict sonarwhal
Create a .sonarwhalrc
file by running this command and following the
instructions:
sonarwhal --init
Scan a website:
sonarwhal https://example.com
For more in depth information on how to get started, configurations, and more, see the online user guide, or the local version for the most recent (and unstable) content.
To know more about the internals of sonarwhal
, the structure of the
project, how to create new rules, collectors, formatters, etc, take a
look at the online contributor
guide (or the local
version).
This project adheres to the JS Foundation’s code of conduct. By participating in this project you agree to abide by its terms.
The code is available under the Apache 2.0 license.