From 86571a530b9faeb36a6cf06ae4384e33e47dbb80 Mon Sep 17 00:00:00 2001 From: Allie Sadler <102604716+aevesdocker@users.noreply.github.com> Date: Wed, 5 Mar 2025 14:01:26 +0000 Subject: [PATCH] ENGDOCS-2438 (#22093) ## Description Move DD CLI to GA Adds new `logs` command Slight wording changes `update` command now available for all OSs but have said 4.39 min version in docs even though it's been available for mac since 4.38 ## Related issues or tickets ## Reviews - [ ] Technical review - [ ] Editorial review - [ ] Product review --- .../manuals/desktop/features/desktop-cli.md | 5 +- content/reference/cli/docker/desktop/logs.md | 8 ++ data/desktop-cli/docker_desktop_logs.yaml | 100 ++++++++++++++++++ data/desktop-cli/docker_desktop_update.yaml | 2 +- data/summary.yaml | 5 +- 5 files changed, 115 insertions(+), 5 deletions(-) create mode 100644 content/reference/cli/docker/desktop/logs.md create mode 100644 data/desktop-cli/docker_desktop_logs.yaml diff --git a/content/manuals/desktop/features/desktop-cli.md b/content/manuals/desktop/features/desktop-cli.md index cd28840f1d..6c188b4a60 100644 --- a/content/manuals/desktop/features/desktop-cli.md +++ b/content/manuals/desktop/features/desktop-cli.md @@ -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). diff --git a/content/reference/cli/docker/desktop/logs.md b/content/reference/cli/docker/desktop/logs.md new file mode 100644 index 0000000000..fefe6c7e7e --- /dev/null +++ b/content/reference/cli/docker/desktop/logs.md @@ -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" >}} \ No newline at end of file diff --git a/data/desktop-cli/docker_desktop_logs.yaml b/data/desktop-cli/docker_desktop_logs.yaml new file mode 100644 index 0000000000..2256e52dba --- /dev/null +++ b/data/desktop-cli/docker_desktop_logs.yaml @@ -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 \ No newline at end of file diff --git a/data/desktop-cli/docker_desktop_update.yaml b/data/desktop-cli/docker_desktop_update.yaml index 55f3a8a371..ab659d47e8 100644 --- a/data/desktop-cli/docker_desktop_update.yaml +++ b/data/desktop-cli/docker_desktop_update.yaml @@ -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 diff --git a/data/summary.yaml b/data/summary.yaml index 2680206225..4a419ddaf7 100644 --- a/data/summary.yaml +++ b/data/summary.yaml @@ -128,10 +128,11 @@ Docker Debug: 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 Init: