Skip to content

Commit 86571a5

Browse files
authored
ENGDOCS-2438 (#22093)
<!--Delete sections as needed --> ## 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 <!-- Related issues, pull requests, or Jira tickets --> ## Reviews <!-- Notes for reviewers here --> <!-- List applicable reviews (optionally @tag reviewers) --> - [ ] Technical review - [ ] Editorial review - [ ] Product review
1 parent 8261c1e commit 86571a5

File tree

5 files changed

+115
-5
lines changed

5 files changed

+115
-5
lines changed

content/manuals/desktop/features/desktop-cli.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ params:
1313

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

16-
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.
16+
The Docker Desktop CLI lets you perform key operations such as starting, stopping, restarting, and updating Docker Desktop directly from the command line.
1717

1818
The Docker Desktop CLI provides:
1919

@@ -36,7 +36,8 @@ docker desktop COMMAND [OPTIONS]
3636
| `status` | Displays whether Docker Desktop is running or stopped. |
3737
| `engine ls` | Lists available engines (Windows only) |
3838
| `engine use` | Switch between Linux and Windows containers (Windows only) |
39-
| `update` | Manage Docker Desktop updates. Available for Mac only and with Docker Desktop version 4.38 and later. |
39+
| `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. |
40+
| `logs` | Print log entries |
4041

4142

4243
For more details on each command, see the [Docker Desktop CLI reference](/reference/cli/docker/desktop/_index.md).
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
datafolder: desktop-cli
3+
datafile: docker_desktop_logs
4+
title: docker desktop logs
5+
layout: cli
6+
---
7+
8+
{{< summary-bar feature_name="Docker Desktop CLI logs" >}}
Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
command: docker desktop logs
2+
short: Print log entries for Docker Desktop
3+
usage: docker desktop logs [OPTIONS]
4+
pname: docker desktop
5+
plink: docker_desktop.yaml
6+
options:
7+
- option: boot
8+
shorthand: b
9+
value_type: init
10+
default_value: false
11+
description: Show logs from a specified boot. Zero means the current or boot, one the second last boot, and so on
12+
deprecated: false
13+
hidden: false
14+
experimental: false
15+
experimentalcli: false
16+
kubernetes: false
17+
swarm: false
18+
- option: color
19+
shorthand: c
20+
value_type: bool
21+
default_value: false
22+
description: Enable colored output. Priority levels are highlighted.
23+
deprecated: false
24+
hidden: false
25+
experimental: false
26+
experimentalcli: false
27+
kubernetes: false
28+
swarm: false
29+
- option: color-mode
30+
shorthand: m
31+
value_type: bool
32+
default_value: default
33+
description: Color mode to use. Can be `default` or `priority`
34+
deprecated: false
35+
hidden: false
36+
experimental: false
37+
experimentalcli: false
38+
kubernetes: false
39+
swarm: false
40+
- option: directory
41+
shorthand: D
42+
value_type: bool
43+
default_value: false
44+
description: Specifies a custom directory to search for log entries
45+
deprecated: false
46+
hidden: false
47+
experimental: false
48+
experimentalcli: false
49+
kubernetes: false
50+
swarm: false
51+
- option: priority
52+
shorthand: p
53+
value_type: init
54+
default_value: -1
55+
description: Filter output by log priorities. `-1` is all, `0` is info or above, `1` filters for warnings or above, `2` filters for errors.
56+
deprecated: false
57+
hidden: false
58+
experimental: false
59+
experimentalcli: false
60+
kubernetes: false
61+
swarm: false
62+
- option: since
63+
shorthand: S
64+
value_type: bool
65+
default_value: false
66+
description: Start showing entries on or newer than the specified date and time. Uses the systemd.time(7) format.
67+
deprecated: false
68+
hidden: false
69+
experimental: false
70+
experimentalcli: false
71+
kubernetes: false
72+
swarm: false
73+
- option: unit
74+
shorthand: u
75+
value_type: bool
76+
default_value: false
77+
description: Filter by one or more categories (e.g. `--unit=com.docker.backend.ipc`, `com.docker.backend.apiproxy`)
78+
deprecated: false
79+
hidden: false
80+
experimental: false
81+
experimentalcli: false
82+
kubernetes: false
83+
swarm: false
84+
- option: until
85+
shorthand: U
86+
value_type: bool
87+
default_value: false
88+
description: Start showing entries on or before the specified date and time. Uses the systemd.time(7) format.
89+
deprecated: false
90+
hidden: false
91+
experimental: false
92+
experimentalcli: false
93+
kubernetes: false
94+
swarm: false
95+
deprecated: false
96+
hidden: false
97+
experimental: false
98+
experimentalcli: false
99+
kubernetes: false
100+
swarm: false

data/desktop-cli/docker_desktop_update.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
command: docker desktop update
2-
short: Manage Docker Desktop updates (Mac only)
2+
short: Manage Docker Desktop updates
33
usage: docker desktop update [OPTIONS]
44
pname: docker desktop
55
plink: docker_desktop.yaml

data/summary.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,10 +128,11 @@ Docker Debug:
128128
Docker Desktop Archlinux:
129129
availability: Experimental
130130
Docker Desktop CLI:
131-
availability: Beta
132131
requires: Docker Desktop [4.37](/manuals/desktop/release-notes.md#4370) and later
133132
Docker Desktop CLI update:
134-
requires: Docker Desktop 4.38 and later
133+
requires: Docker Desktop 4.39 and later
134+
Docker Desktop CLI logs:
135+
requires: Docker Desktop 4.39 and later
135136
Docker GitHub Copilot:
136137
availability: Early Access
137138
Docker Init:

0 commit comments

Comments
 (0)