Skip to content

Desktop: new CLI command #24063

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aevesdocker wants to merge 1 commit into
base: main
Choose a base branch
from
+37 −0
Open

Desktop: new CLI command #24063

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions content/manuals/desktop/features/desktop-cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,6 @@ docker desktop COMMAND [OPTIONS]
| `enable` | Enable a feature |
| `version` | Show the Docker Desktop CLI plugin version information |
| `kubernetes` | List Kubernetes images used by Docker Desktop or restart the cluster. Available with Docker Desktop version 4.44 and later. |
| `diagnose`. | Diagnose Docker Desktop and upload the diagnostics. Available with Docker Desktop 4.60 and later. |

For more details on each command, see the [Docker Desktop CLI reference](/reference/cli/docker/desktop/_index.md).
4 changes: 4 additions & 0 deletions content/manuals/desktop/troubleshoot-and-support/troubleshoot/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,10 @@ After the diagnostics have finished, the terminal displays your diagnostics ID a
{{< /tab >}}
{{< /tabs >}}

> [!TIP]
>
> You can also use the [`docker desktop diagnose` command](/manuals/desktop/features/desktop-cli.md) to diagnose Docker Desktop and upload the diagnostics ID.

To view the contents of the diagnostic file:

{{< tabs group="os" >}}
Expand Down
8 changes: 8 additions & 0 deletions content/reference/cli/docker/desktop/diagnose.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
datafolder: desktop-cli
datafile: docker_desktop_diagnose
title: docker desktop diagnose
layout: cli
---

{{< summary-bar feature_name="Docker Desktop CLI diagnose" >}}
22 changes: 22 additions & 0 deletions data/desktop-cli/docker_desktop_diagnose.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
command: docker desktop diagnose
short: Diagnose Docker Desktop issues
usage: docker desktop diagnose [OPTIONS]
pname: docker desktop diagnose
plink: docker_desktop_diagnose.yaml
options:
- option: upload
shorthand: u
value_type: bool
default_value: "false"
description: Uploads the diagnostic ID.
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
2 changes: 2 additions & 0 deletions data/summary.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,8 @@ Docker Desktop CLI logs:
requires: Docker Desktop 4.39 and later
Docker Desktop CLI kubernetes:
requires: Docker Desktop 4.44 and later
Docker Desktop CLI diagnose:
requires: Docker Desktop 4.60 and later
Docker Hardened Images:
subscription: [Docker Hardened Images Enterprise]
Docker Init:
Expand Down