# Getting help

> **Warning:** This product is in Beta stage and we may release breaking changes. The documentation here matches the release version listed in the table of contents.

## In-terminal help

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

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

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, Git hooks.
* [Analysis](/sonarqube-cli/analysis/analysis.md) — secrets, local change analysis, AI remediation.

You can also browse the standalone command reference at [cli.sonarqube.com/commands.html](https://cli.sonarqube.com/commands.html) and the project website at [cli.sonarqube.com](https://cli.sonarqube.com/). 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.

## 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](https://forms.gle/xE61HS2E5NzxFCSR9).

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

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

The question should be specific, self-contained, and written in natural language.
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.