> 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/administration/system-status.md).
# Check system status
Check SonarQube CLI authentication, network settings, binaries, and integrations with \`sonar system status\`.
`sonar system status` gives you a single diagnostic view of your SonarQube CLI installation: whether your token is valid, which proxy, custom CA certificate, and client certificate settings the CLI resolved, which auxiliary binaries are installed, which integrations are configured, Vortex entitlement and usage when you're authenticated to an entitled connection, and whether a CLI update is available.
The command does not require authentication. It still reports whether saved credentials exist and, when possible, verifies the token against your SonarQube server.
## Run the status check
```bash
sonar system status
```
The output starts with a banner and a system check headline:
* **SYSTEM CHECK: Healthy** when authentication and integration configuration look good.
* **SYSTEM CHECK: Issues found** when the token is missing or invalid, when an MCP config file is present but malformed, when an Antigravity secrets hook is installed but its configuration or backing script is invalid, when client certificate configuration is invalid, or when Vortex is installed but your connection is no longer entitled to it.
Authentication is reported as one of:
* **Not Set**: no active connection in `state.json`
* **Active**: token validated successfully
* **Invalid**: token rejected by the server
* **Set Unverified**: a token is stored but the server could not be reached to validate it. When the failure is due to a network or TLS problem, the output includes the underlying error message (for example, a connection timeout or certificate error).
## What the report includes
| Section | What it shows |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Authentication** | Active server URL, organization (SonarQube Cloud), and the current token state. |
| **Binaries** | Auxiliary tools the CLI downloaded (for example, the secrets engine and SCA scanner), their paths, versions, and whether a newer pinned version is available. |
| **Cache** | Whether log, SCA scanner cache, and global Git hook directories exist under `~/.sonar/sonarqube-cli/`. |
| **Integrations** | Each `sonar integrate` install with its config path. For most agents, MCP Server status is shown (not configured, configured, or invalid config). For Antigravity, Secrets Hook status is also shown when a secrets hook is recorded in state. |
| **Network** | Resolved proxy, custom CA certificate, and client certificate settings, including the configuration source (`SONAR_` *environment variables, stored `network.`* `sonar config` keys, or generic `HTTPS_PROXY` / `NODE_EXTRA_CA_CERTS` variables). Proxy URLs redact embedded credentials. When a client certificate is configured, the section lists the certificate path and, for PEM files, the key path. For PKCS#12 bundles (`.p12` or `.pfx`), the key path is omitted and passphrase status is shown instead. When client certificate configuration is invalid, the section shows the error. When nothing is configured, the section reports that no advanced network configuration was detected. See [Advanced network configuration](/sonarqube-cli/administration/advanced-network-configuration.md) for details. The SonarQube MCP server launched by the CLI uses these settings. A note warns that not all CLI features currently honor proxy and certificate settings (for example, secrets hooks, Vortex context, and Software Composition Analysis). See [environment-variables.md](/sonarqube-cli/using-sonarqube-cli/environment-variables.md#network-connectivity). |
| **Vortex** | When you're authenticated to a SonarQube Cloud or SonarQube Server 2026.5 or newer Enterprise or Data Center edition connection. Shows entitlement status and Vortex context usage against your plan limit. Omitted when Vortex does not apply to your connection. Status values: **Active**, **Active (quota exhausted)**, **Not entitled**, **Not available**, **Unknown (check failed)**, or **Configured organization is not accessible with this token**. Usage numbers appear on SonarQube (Server, Cloud) while you're entitled; they're omitted once your quota is exhausted. Entitlement loss marks the check unhealthy only when Vortex is installed through `sonar integrate`; quota exhaustion, check failures, and organization membership mismatches stay healthy. For a membership mismatch, run [`sonar auth status`](/sonarqube-cli/using-sonarqube-cli/commands.md#sonar-auth-status) for next steps. |
| **Recommendations** | Suggested next steps such as `sonar auth login`, `sonar update` (standalone builds only), fixing invalid client certificate configuration, re-running an integrate command to fix MCP or secrets hook configuration, or re-enabling Vortex, asking your administrator (SonarQube Server), or removing its integration when entitlement is lost. |
For token verification details, see [`sonar auth status`](/sonarqube-cli/using-sonarqube-cli/commands.md#sonar-auth-status). For what reset clears, see [Reset the CLI](/sonarqube-cli/administration/system-reset.md).
## Machine-readable output
For scripts and automation, pass `--format json`:
```bash
sonar system status --format json
```
`--json` has been deprecated since 1.9 and will be removed in a future version. It still prints the same JSON as `--format json`, and the CLI prints a deprecation warning on stderr. Use `--format json` instead. Passing `--json` selects JSON even when `--format` is also set.
The JSON document includes the CLI version, authentication summary, a `network` object (proxy URLs, `noProxy` list, CA certificate path, `clientCertificate` object with certificate path, optional key path for PEM files, `passphraseSet` for PKCS#12 bundles, or an `error` when configuration is invalid, and human-readable source labels), binaries, cache directories, integrations, MCP configuration flags, Antigravity secrets hook flags (`configured` and `valid` under `hooks` when applicable), a `vortex` object, a top-level `healthy` boolean, and a `recommendations` array. Token state in JSON uses `not_set`, `active`, `invalid`, or `set_unverified`. When token verification fails because the server is unreachable, the authentication object may also include `tokenError` with the underlying network or TLS message.
The `vortex` object is `{ "applicable": false }` when Vortex status does not apply (for example, SonarQube Server before 2026.5 Enterprise, or SonarQube Cloud without a resolved organization). When applicable, it includes `applicable: true`, a `status` of `enabled`, `over_consumption`, `not_entitled`, `check_failed`, or `organization_not_accessible`, and a `consumption` object with `consumed` and `limit` only on SonarQube Cloud while you're actively entitled.
## When to use it
* After `sonar auth login` or when integrations stop working: confirm the token, network settings, MCP config, Vortex entitlement, and (for Antigravity) secrets hook are healthy
* Before filing a support request: capture the status output
* In CI diagnostics when the CLI behaves unexpectedly but commands still run
## Related pages
* [Commands reference](/sonarqube-cli/using-sonarqube-cli/commands.md)
* [Reset the CLI](/sonarqube-cli/administration/system-reset.md)
* [State and storage](/sonarqube-cli/administration/state-and-storage.md)
* [Advanced network configuration](/sonarqube-cli/administration/advanced-network-configuration.md)
* [Output formats](/sonarqube-cli/using-sonarqube-cli/output-formats.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 by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.sonarsource.com/sonarqube-cli/administration/system-status.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
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.