Skip to content
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.

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

ENGDOCS-2438 #22093

Merged
merged 3 commits into from
Mar 5, 2025
Merged
Changes from all commits
Commits
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
5 changes: 3 additions & 2 deletions content/manuals/desktop/features/desktop-cli.md
Original file line number Diff line number Diff line change
@@ -13,7 +13,7 @@ params:

{{< summary-bar feature_name="Docker Desktop CLI" >}}

The Docker Desktop CLI lets you perform key operations such as starting, stopping, restarting, and checking the status of Docker Desktop directly from the command line.
The Docker Desktop CLI lets you perform key operations such as starting, stopping, restarting, and updating Docker Desktop directly from the command line.

The Docker Desktop CLI provides:

@@ -36,7 +36,8 @@ docker desktop COMMAND [OPTIONS]
| `status` | Displays whether Docker Desktop is running or stopped. |
| `engine ls` | Lists available engines (Windows only) |
| `engine use` | Switch between Linux and Windows containers (Windows only) |
| `update` | Manage Docker Desktop updates. Available for Mac only and with Docker Desktop version 4.38 and later. |
| `update` | Manage Docker Desktop updates. Available for Mac only with Docker Desktop version 4.38, or all OSs with Docker Desktop version 4.39 and later. |
| `logs` | Print log entries |


For more details on each command, see the [Docker Desktop CLI reference](/reference/cli/docker/desktop/_index.md).
8 changes: 8 additions & 0 deletions content/reference/cli/docker/desktop/logs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
datafolder: desktop-cli
datafile: docker_desktop_logs
title: docker desktop logs
layout: cli
---

{{< summary-bar feature_name="Docker Desktop CLI logs" >}}
100 changes: 100 additions & 0 deletions data/desktop-cli/docker_desktop_logs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
command: docker desktop logs
short: Print log entries for Docker Desktop
usage: docker desktop logs [OPTIONS]
pname: docker desktop
plink: docker_desktop.yaml
options:
- option: boot
shorthand: b
value_type: init
default_value: false
description: Show logs from a specified boot. Zero means the current or boot, one the second last boot, and so on
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: color
shorthand: c
value_type: bool
default_value: false
description: Enable colored output. Priority levels are highlighted.
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: color-mode
shorthand: m
value_type: bool
default_value: default
description: Color mode to use. Can be `default` or `priority`
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: directory
shorthand: D
value_type: bool
default_value: false
description: Specifies a custom directory to search for log entries
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: priority
shorthand: p
value_type: init
default_value: -1
description: Filter output by log priorities. `-1` is all, `0` is info or above, `1` filters for warnings or above, `2` filters for errors.
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: since
shorthand: S
value_type: bool
default_value: false
description: Start showing entries on or newer than the specified date and time. Uses the systemd.time(7) format.
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: unit
shorthand: u
value_type: bool
default_value: false
description: Filter by one or more categories (e.g. `--unit=com.docker.backend.ipc`, `com.docker.backend.apiproxy`)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: until
shorthand: U
value_type: bool
default_value: false
description: Start showing entries on or before the specified date and time. Uses the systemd.time(7) format.
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
2 changes: 1 addition & 1 deletion data/desktop-cli/docker_desktop_update.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
command: docker desktop update
short: Manage Docker Desktop updates (Mac only)
short: Manage Docker Desktop updates
usage: docker desktop update [OPTIONS]
pname: docker desktop
plink: docker_desktop.yaml
5 changes: 3 additions & 2 deletions data/summary.yaml
Original file line number Diff line number Diff line change
@@ -125,10 +125,11 @@ docker compose alpha:
Docker Desktop Archlinux:
availability: Experimental
Docker Desktop CLI:
availability: Beta
requires: Docker Desktop [4.37](/manuals/desktop/release-notes.md#4370) and later
Docker Desktop CLI update:
requires: Docker Desktop 4.38 and later
requires: Docker Desktop 4.39 and later
Docker Desktop CLI logs:
requires: Docker Desktop 4.39 and later
Docker GitHub Copilot:
availability: Early Access
Docker Scout exceptions: