Skip to content

Commit 782e611

Browse files
aevesdockeraevesdocker
authored
ENGDOCS-2342 (#21573)
<!--Delete sections as needed --> ## Description New DD CLI feature for 4.37. Followed the way docker debug was added to the CLI reference ## 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 b8a770e commit 782e611

20 files changed

+259
-3
lines changed

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

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: Using the Docker Desktop CLI
3+
linkTitle: Docker Desktop CLI
4+
weight: 120
5+
description: How to use the Docker Desktop CLI
6+
keywords: cli, docker desktop, macos, windows, linux
7+
params:
8+
sidebar:
9+
badge:
10+
color: green
11+
text: New
12+
---
13+
14+
{{% experimental title="Beta" %}}
15+
Docker Desktop CLI is currently in [Beta](../../release-lifecycle.md#beta).
16+
{{% /experimental %}}
17+
18+
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. It is available with Docker Desktop version 4.37 and later.
19+
20+
The Docker Desktop CLI provides:
21+
22+
- Enhanced automation and CI/CD integration: Perform Docker Desktop operations directly in CI/CD pipelines for better workflow automation.
23+
- An improved developer experience: Restart, quit, or reset Docker Desktop from the command line, reducing dependency on the Docker Desktop Dashboard and improving flexibility and efficiency.
24+
25+
## Usage
26+
27+
```console
28+
docker desktop COMMAND [OPTIONS]
29+
```
30+
31+
## Commands
32+
33+
| Command | Description |
34+
|:---------------------|:-----------------------------------------|
35+
| `start` | Starts Docker Desktop |
36+
| `stop` | Stops Docker Desktop |
37+
| `restart` | Restarts Docker Desktop |
38+
| `status` | Displays whether Docker Desktop is running or stopped. |
39+
| `engine ls` | Lists available engines (Windows only) |
40+
| `engine use` | Switch between Linux and Windows containers (Windows only) |
41+
42+
For more details on each command, see the [Docker Desktop CLI reference](/reference/cli/docker/desktop/_index.md).

‎content/manuals/desktop/features/usbip.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Using USB/IP with Docker Desktop
33
linkTitle: USB/IP support
4-
weight: 80
4+
weight: 100
55
description: How to use USB/IP in Docker Desktop
66
keywords: usb, usbip, docker desktop, macos, windows, linux
77
toc_max: 3

‎content/manuals/desktop/features/vmm.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ params:
88
text: New
99
keywords: virtualization software, resource allocation, mac, docker desktop, vm monitoring, vm performance, apple silicon
1010
description: Discover Docker Desktop for Mac's Virtual Machine Manager (VMM) options, including the new Docker VMM for Apple Silicon, offering enhanced performance and efficiency
11-
weight: 90
11+
weight: 110
1212
aliases:
1313
- /desktop/vmm/
1414
---

‎content/manuals/desktop/features/wsl/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ keywords: wsl, wsl2, installing wsl2, wsl installation, docker wsl2, wsl docker,
55
tech preview, wsl install docker, install docker wsl, how to install docker in wsl
66
title: Docker Desktop WSL 2 backend on Windows
77
linkTitle: WSL
8-
weight: 100
8+
weight: 90
99
aliases:
1010
- /docker-for-windows/wsl/
1111
- /docker-for-windows/wsl-tech-preview/

‎content/reference/cli/docker/desktop/_index.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
datafolder: desktop-cli
3+
datafile: docker_desktop
4+
title: docker desktop (Beta)
5+
layout: cli
6+
---
7+
8+
{{% experimental title="Beta" %}}
9+
Docker Desktop CLI is currently in [Beta](/manuals/release-lifecycle.md#beta).
10+
{{% /experimental %}}

‎content/reference/cli/docker/desktop/engine/_index.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
datafolder: desktop-cli
3+
datafile: docker_desktop_engine
4+
title: docker desktop engine
5+
layout: cli
6+
---

‎content/reference/cli/docker/desktop/engine/ls.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
datafolder: desktop-cli
3+
datafile: docker_desktop_engine_ls
4+
title: docker desktop engine ls
5+
layout: cli
6+
---

‎content/reference/cli/docker/desktop/engine/use.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
datafolder: desktop-cli
3+
datafile: docker_desktop_engine_use
4+
title: docker desktop engine use
5+
layout: cli
6+
---

‎content/reference/cli/docker/desktop/restart.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
datafolder: desktop-cli
3+
datafile: docker_desktop_restart
4+
title: docker desktop restart
5+
layout: cli
6+
---

‎content/reference/cli/docker/desktop/start.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
datafolder: desktop-cli
3+
datafile: docker_desktop_start
4+
title: docker desktop start
5+
layout: cli
6+
---
7+
8+
> [!NOTE]
9+
>
10+
> `docker desktop start` does not work when executed via SSH on Windows due to a limitation in how WinCred stores credentials securely.

0 commit comments

Comments
 (0)