Skip to content

Commit 01b4940

Browse files
aevesdockeraevesdocker
committed
ENGDOCS-2342
1 parent 0c71c3b commit 01b4940

File tree

17 files changed

+233
-0
lines changed

17 files changed

+233
-0
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: 1000
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/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: 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_start
4+
title: docker desktop start
5+
layout: cli
6+
---

‎content/reference/cli/docker/desktop/status.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_status
4+
title: docker desktop status
5+
layout: cli
6+
---

‎content/reference/cli/docker/desktop/stop.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_stop
4+
title: docker desktop stop
5+
layout: cli
6+
---

‎data/desktop-cli/docker_desktop.yaml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
command: docker desktop
2+
short: Docker Desktop
3+
long: Control Docker Desktop from the CLI
4+
usage: docker desktop
5+
pname: docker
6+
plink: docker.yaml
7+
cname:
8+
- docker desktop start
9+
- docker desktop stop
10+
- docker desktop restart
11+
- docker desktop status
12+
- docker desktop engine
13+
clink:
14+
- docker_desktop_start.yaml
15+
- docker_desktop_stop.yaml
16+
- docker_desktop_restart.yaml
17+
- docker_desktop_status.yaml
18+
- docker_desktop_engine.yaml
19+
deprecated: false
20+
hidden: false
21+
experimental: false
22+
experimentalcli: false
23+
kubernetes: false
24+
swarm: false

0 commit comments

Comments
 (0)