Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.
Developer

Getting help

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

Get help with the SonarQube CLI through built-in terminal commands, community support, and bug reports.

In-terminal help

The fastest way to look something up is the built-in help. Run sonar with no arguments, or append --help (or -h) to any command:

sonar                           # root help (grouped by category)
sonar --help
sonar auth login --help         # one command in detail
sonar integrate --help
sonar integrate claude --help

Root help groups commands into core (analysis and link), data (list, quality gate, API, context), integrate, and cli-management (auth, config, system, and update on standalone builds) sections. When a command has a shortcut alias, root help shows it as command|alias (for example, quality-gate|qg).

Beta, alpha, and deprecated commands

Some commands and options are marked as Beta, Alpha, or Deprecated in help output:

  • Beta commands show a [BETA] tag in root and command help. They remain fully available. The first time you run a Beta command after installing or upgrading the CLI, you'll see an info message on stderr that the command is in beta and may change. You will not see that message again for the same command until the next CLI upgrade.

  • Alpha commands are hidden unless you set SONARQUBE_CLI_ALPHA=1 (or true). When enabled, they appear in a separate Alpha section at the bottom of root help.

  • Deprecated commands and options show a [DEPRECATED] tag in help. They stay available. Each time you run a deprecated command or pass a deprecated option, the CLI prints a warning that names the version when it was deprecated and, when there's one, what to use instead.

The commands reference documents Beta commands and notes deprecated hidden aliases next to their replacements. Alpha commands are intentionally omitted from published documentation.

To check which version you're running:

Documentation

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

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

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

  • Analysis: local change analysis, AI remediation, secrets detection, and SCA.

  • Administration: state and storage, telemetry, system status, reset, CLI update, and uninstall.

Browse the standalone command reference and the project website at sonarsource.com/sonarqube/cli. 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 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 do not get an answer to your thread, 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.

Bug reports and crashes

For bugs, crashes, and other reproducible defects, 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.

Feedback

Share what's working, what is not, 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. Local analyzer stats stay on your machine and use a separate opt-out on that page.

Related pages

PreviousUninstalling
NextFrequently asked questions

Last updated

Was this helpful?