Instant Sonar

Instantly analyse your code with SonarQube in Docker, with a single command.

Usage

Simply download the appropriate binary for your platform from the latest release and execute it.

To analyse your current working directory:

instant-sonar

To analyse a different directory:

instant-sonar "path/to/project"

For all help and options:

instant-sonar --help

Performance Note (Mac + Windows)

On Mac and Windows, using a bound volume for the Sonar Scanner can induce a performance hit. To improve this, there is a "copy" flag (-c or --copy), which will copy files into the Sonar Scanner container instead of binding a volume. On Linux, using this option is slower than using a bound volume.

What it Does

Instant Sonar will start a SonarQube container, configure it so it can be accessed without having to log in, and set up a new project. It will then start a Sonar Scanner container, which will run the project analysis and send the results to SonarQube. After this is done, it will output a link which you can use to view the analysis results.

Is something not working as intended? Feel free to create an issue!