Help

How to get help with SonarQube CLI commands.

Getting help

Run sonar --help for a reminder of commands you can use.

Append --help to any command to see usage details.

Examples:

sonar --help
sonar auth login --help
sonar install --help

The Sonar Community

For SonarQube CLI support questions ("How do I?", "I got this error, why?", …), please first check the sonar --help command, then head to the Sonar Community forum. Before creating a new topic, please check if your question has already been answered because there is a chance that someone has already had the same issue.

When creating a new topic, please describe your issue with as much detail as possible. Please use this template:

• Your SonarQube CLI version (when applicable).

• Are you connecting to SonarQube Cloud, SonarQube Server, or the SonarQube Community Build?

• If you are using SonarQube Server or the SonarQube Community Build:

  • Which version do you have?

  • What are the installed analyzers? You can easily get a list by opening https://<YourSonarQubeServerURL>/api/plugins/installed in a Web browser.

Be aware that the Sonar Community Forum is a community, and the standard pleasantries are expected (Hello, Thank you, I appreciate the reply, etc). If you don’t get an answer to your thread, please wait for at least three days before bumping it. Operators are not standing by, but the Teams and Community Managers know that your questions are important.

How to contribute

If you would like to see a new feature, check out the Suggest new features topic on the Community! There we provide a forum to discuss your needs and offer you a chance to engage the Product Manager and development teams directly. Feel free to add to an ongoing discussion or create a new thread if you have something new to bring up.