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

# Collect diagnostics for support

Collect a Devolutions CLI diagnostics snapshot with devo doctor and the details support needs, without sharing any secret value.

When a problem isn't solved by the other troubleshooting pages, Devolutions support needs to know which version you run, how `devo` is set up on your computer, and the exact error. `devo doctor` gathers most of it in one command, without reading any secret.

## Run devo doctor

```bash
devo doctor
```

It shows a snapshot of your installation:

<table><thead><tr><th width="260">LINE</th><th>WHAT IT TELLS</th></tr></thead><tbody><tr><td><code>CLI version</code></td><td>The version of Devolutions CLI.</td></tr><tr><td><code>Executable</code>, <code>Base directory</code></td><td>Which <code>devo</code> file ran, and from where.</td></tr><tr><td><code>Registry</code></td><td>Where the background processes are registered.</td></tr><tr><td><code>Daemon running</code> or <code>Daemon not running</code></td><td>Whether a background process is up. When several are registered, this is the preferred one, which can serve another configuration folder than yours: in that case, a <code>Hint</code> line says so.</td></tr><tr><td><code>Runtime loaded</code> and the lines that follow</td><td>For the running background process: the configuration folder, the workspace in use, the services that are available or blocked, and the operations the workspace supports.</td></tr><tr><td><code>Sessions</code></td><td>How many background processes are registered.</td></tr><tr><td><code>Hint</code></td><td>What to try next, when something looks wrong.</td></tr></tbody></table>

`devo doctor` never starts the background process: it reports on the one that's running, if any. It contains versions, file paths, and status, not secret values.

To attach the result to a ticket, save it as JSON:

```bash
devo doctor --output json > devo-doctor.json
```

{% hint style="warning" %}
File paths can contain your user name or folder names. Read the file before you send it, and remove anything you don't want to share.
{% endhint %}

## Add the details of the problem

1. Write down the command you ran, as you typed it. References (`devo://…`) can stay: they hold no secret value.
2. Run it again with `--verbose`, and copy the full output, including the error code and message:

   ```bash
   devo <your-command> --verbose
   ```

   `--verbose` adds lifecycle notices, such as when the background process starts, on the standard error stream.
3. For a scripted run, add `--output json` too: the error comes as a JSON document with its code and message.
4. Add the output of these commands, as relevant:

<table><thead><tr><th width="300">COMMAND</th><th>USE IT FOR</th></tr></thead><tbody><tr><td><code>devo status</code></td><td>Which context and workspace type the command used.</td></tr><tr><td><code>devo daemon sessions --details</code></td><td>Problems with the background process.</td></tr><tr><td><code>devo runtime status</code></td><td>Problems with a local Devolutions Remote Desktop Manager profile.</td></tr><tr><td><code>devo secret capabilities</code></td><td>Fields a workspace type can't read or write.</td></tr></tbody></table>

## What never to send

{% hint style="danger" %}
Never send a password, an API key, an application secret, a token, or any secret value, even in a screenshot. Don't add the output of `devo secret read`, `devo secret get`, `devo secret inject`, or `devo secret shell enter`, which contain secret values, nor output produced with `--no-masking`.
{% endhint %}

## Contact support

Send the information above to [Devolutions support](https://devolutions.net/support/).

## Related

* [Troubleshooting](/cli/help/troubleshooting.md)
* [Exit codes and errors](/cli/reference/exit-codes-and-errors.md)
* [What stays hidden, and what doesn't](/cli/guides/understand/security-model.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.devolutions.net/cli/help/troubleshooting/collect-diagnostics.md?ask=<question>&goal=<user_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.