> For the complete documentation index, see [llms.txt](https://docs.sonarsource.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sonarsource.com/sonarqube-cli/support/help.md).

# Getting help

## 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:

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

Root help groups commands into **core** (analysis), **data** (list, API, context), **integrate**, and **cli-management** (auth, config, system, and `self-update` on standalone builds) sections.

To check which version you're running:

```bash
sonar --version
```

## Documentation

* [Quickstart guide](/sonarqube-cli/quickstart-guide.md): install, authenticate, run your first command.
* [Commands reference](/sonarqube-cli/using-sonarqube-cli/commands.md): every command, option, and example.
* [Integrations](/sonarqube-cli/integrations/integrations.md): Claude Code, GitHub Copilot, OpenAI Codex, Git hooks.
* [Analysis](/sonarqube-cli/analysis/analysis.md): secrets, local change analysis, AI remediation.

You can also browse the standalone command reference at <https://www.sonarsource.com/sonarqube/cli/commands#sonar-auth-login> and the project website at [sonarsource.com/sonarqube/cli](https://sonarsource.com/sonarqube/cli/). Source code lives at [github.com/SonarSource/sonarqube-cli](https://github.com/SonarSource/sonarqube-cli).

## Community forum

For "how do I…" or "I got this error, why?" questions, head to the [Sonar Community forum](https://community.sonarsource.com/). 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](https://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](https://community.sonarsource.com/tags/c/suggestions/12/sonarqube-ide) topic on the forum. That's where the product team watches for proposals and engages directly.

## Feedback

Share what's working, what isn't, and what you'd like next via the [feedback form](https://forms.gle/jrGic3awT5t5vf7V9).

## 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](/sonarqube-cli/administration/telemetry-and-privacy.md).

## Related pages <a href="#related-pages" id="related-pages"></a>

* [Quickstart guide](/sonarqube-cli/quickstart-guide.md)
* [Commands reference](/sonarqube-cli/using-sonarqube-cli/commands.md)
* [Uninstalling](/sonarqube-cli/administration/uninstall.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.sonarsource.com/sonarqube-cli/support/help.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.