Skip to content

ENGDOCS-2405a #21917

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

Merged
merged 4 commits into from
Jan 30, 2025
Merged

ENGDOCS-2405a #21917

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2b97947
ENGDOCS-2405a
aevesdocker Jan 29, 2025
80c7a68
ENGDOCS-2405a
aevesdocker Jan 29, 2025
cf48a9c
summary bar addition
aevesdocker Jan 29, 2025
b82dfea
Merge branch 'main' into ENGDOCS-2405a
aevesdocker Jan 30, 2025
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
4 changes: 3 additions & 1 deletion content/manuals/desktop/features/desktop-cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ docker desktop COMMAND [OPTIONS]
| `restart` | Restarts Docker Desktop |
| `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) |
| `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. |


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/update.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_update
title: docker desktop update
layout: cli
---

{{< summary-bar feature_name="Docker Desktop CLI update" >}}
2 changes: 2 additions & 0 deletions data/desktop-cli/docker_desktop.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,14 @@ cname:
- docker desktop restart
- docker desktop status
- docker desktop engine
- docker desktop update
clink:
- docker_desktop_start.yaml
- docker_desktop_stop.yaml
- docker_desktop_restart.yaml
- docker_desktop_status.yaml
- docker_desktop_engine.yaml
- docker_desktop_update.yaml
deprecated: false
hidden: false
experimental: false
Expand Down
34 changes: 34 additions & 0 deletions data/desktop-cli/docker_desktop_update.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
command: docker desktop update
short: Manage Docker Desktop updates (Mac only)
usage: docker desktop update [OPTIONS]
pname: docker desktop
plink: docker_desktop.yaml
options:
- option: check-only
shorthand: k
value_type: bool
default_value: false
description: Check for updates without applying them
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet
shorthand: q
value_type: bool
default_value: false
description: Queitly check and apply updates
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
3 changes: 3 additions & 0 deletions data/summary.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,9 @@ Docker Desktop Archlinux:
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
Copy link
Contributor

@sarahsanders-docker sarahsanders-docker Jan 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if you want to add release notes here (not sure if you want to or not!) you can use markdown around the version number. Docker Desktop [4.38](release-notes-url) and later

Copy link
Contributor Author

@aevesdocker aevesdocker Jan 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah yes! Will add in a follow-up once those release notes are out

Copy link
Contributor

@dvdksn dvdksn Jan 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if "Docker Desktop CLI update" will be easy to remember what it means in the future? Is there a better/more semantic feature id that we could use? (This is probably a good idea generally - I have not reviewed the feature IDs in this file so far, but if they are too generic, it'll be difficult to keep track of them down the line. How do we manage this inventory of feaures?)

Copy link
Contributor Author

@aevesdocker aevesdocker Jan 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Having a standardised pattern is a good idea. Something like {product}-{feature-category}-{specific-feature} perhaps

Copy link
Contributor

@dvdksn dvdksn Jan 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah something like that

requires:
Docker GitHub Copilot:
availability: Early access
Docker Scout exceptions:
Expand Down