Getting help

Get help with the SonarQube CLI: built-in command help, community support, bug reports, and feature requests.

Warning: This product is in Beta stage and we may release breaking changes.

In-terminal help

The fastest way to look something up is the built-in help. Append --help (or -h) to any command:

sonar --help                    # top-level commands
sonar auth login --help         # one command in detail
sonar integrate claude --help

To check which version you're running:

sonar --version

Documentation

• Quickstart guide: install, authenticate, run your first command.

• Commands reference: every command, option, and example.

• Integrations: Claude Code, GitHub Copilot, OpenAI Codex, Git hooks.

• Analysis: secrets, local change analysis, AI remediation.

You can also browse the standalone command reference at cli.sonarqube.com/commands.html and the project website at cli.sonarqube.com. Source code lives at github.com/SonarSource/sonarqube-cli.

Community forum

For "how do I…" or "I got this error, why?" questions, head to the Sonar Community forum. Before opening a new topic, search to see whether someone has already had the same issue.

When you start a thread, include:

• The output of sonar --version.

• Whether you're connecting to SonarQube Cloud (EU or US region), SonarQube Server, or SonarQube Community Build.

• If you're on SonarQube Server or Community Build:

  • The version of your instance.

  • The list of installed analyzers (open https://<YourSonarQubeServerURL>/api/plugins/installed in a browser to get one).

• The full command you ran and the output you got (redact any tokens or secrets first).

Be polite; it goes a long way. If you don't get a reply, wait at least three days before bumping your thread.

Bug reports and crashes

For bugs, crashes, and other reproducible defects, please open an issue on GitHub: github.com/SonarSource/sonarqube-cli/issues.

Include:

• The output of sonar --version.

• Your operating system and version.

• The exact command you ran (redact tokens and secrets).

• The full output you got, including any stack trace.

• What you expected to happen.

Suggesting new features

If you have an idea for something the CLI should do, post it on the Suggest new features topic on the forum. That's where the product team watches for proposals and engages directly.

Beta feedback

The SonarQube CLI is in Beta. Share what's working, what isn't, and what you'd like next via the feedback form.

Privacy and data collection

For information on what the CLI sends home (anonymous usage telemetry and Sentry crash reports) and how to disable it, see Telemetry and privacy.

Related pages

• Quickstart guide

• Commands reference

• Uninstalling