-
Notifications
You must be signed in to change notification settings - Fork 7.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
<!--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
- Loading branch information
1 parent
b8a770e
commit 782e611
Showing
20 changed files
with
259 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
--- | ||
title: Using the Docker Desktop CLI | ||
linkTitle: Docker Desktop CLI | ||
weight: 120 | ||
description: How to use the Docker Desktop CLI | ||
keywords: cli, docker desktop, macos, windows, linux | ||
params: | ||
sidebar: | ||
badge: | ||
color: green | ||
text: New | ||
--- | ||
|
||
{{% experimental title="Beta" %}} | ||
Docker Desktop CLI is currently in [Beta](../../release-lifecycle.md#beta). | ||
{{% /experimental %}} | ||
|
||
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. | ||
|
||
The Docker Desktop CLI provides: | ||
|
||
- Enhanced automation and CI/CD integration: Perform Docker Desktop operations directly in CI/CD pipelines for better workflow automation. | ||
- 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. | ||
|
||
## Usage | ||
|
||
```console | ||
docker desktop COMMAND [OPTIONS] | ||
``` | ||
|
||
## Commands | ||
|
||
| Command | Description | | ||
|:---------------------|:-----------------------------------------| | ||
| `start` | Starts Docker Desktop | | ||
| `stop` | Stops Docker Desktop | | ||
| `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) | | ||
|
||
For more details on each command, see the [Docker Desktop CLI reference](/reference/cli/docker/desktop/_index.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
datafolder: desktop-cli | ||
datafile: docker_desktop | ||
title: docker desktop (Beta) | ||
layout: cli | ||
--- | ||
|
||
{{% experimental title="Beta" %}} | ||
Docker Desktop CLI is currently in [Beta](/manuals/release-lifecycle.md#beta). | ||
{{% /experimental %}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
datafolder: desktop-cli | ||
datafile: docker_desktop_engine | ||
title: docker desktop engine | ||
layout: cli | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
datafolder: desktop-cli | ||
datafile: docker_desktop_engine_ls | ||
title: docker desktop engine ls | ||
layout: cli | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
datafolder: desktop-cli | ||
datafile: docker_desktop_engine_use | ||
title: docker desktop engine use | ||
layout: cli | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
datafolder: desktop-cli | ||
datafile: docker_desktop_restart | ||
title: docker desktop restart | ||
layout: cli | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
datafolder: desktop-cli | ||
datafile: docker_desktop_start | ||
title: docker desktop start | ||
layout: cli | ||
--- | ||
|
||
> [!NOTE] | ||
> | ||
> `docker desktop start` does not work when executed via SSH on Windows due to a limitation in how WinCred stores credentials securely. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
datafolder: desktop-cli | ||
datafile: docker_desktop_status | ||
title: docker desktop status | ||
layout: cli | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
datafolder: desktop-cli | ||
datafile: docker_desktop_stop | ||
title: docker desktop stop | ||
layout: cli | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
command: docker desktop | ||
short: Docker Desktop | ||
long: Control Docker Desktop from the CLI | ||
usage: docker desktop | ||
pname: docker | ||
plink: docker.yaml | ||
cname: | ||
- docker desktop start | ||
- docker desktop stop | ||
- docker desktop restart | ||
- docker desktop status | ||
- docker desktop engine | ||
clink: | ||
- docker_desktop_start.yaml | ||
- docker_desktop_stop.yaml | ||
- docker_desktop_restart.yaml | ||
- docker_desktop_status.yaml | ||
- docker_desktop_engine.yaml | ||
deprecated: false | ||
hidden: false | ||
experimental: false | ||
experimentalcli: false | ||
kubernetes: false | ||
swarm: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
command: docker desktop engine | ||
short: Commands to list and switch containers (Windows only) | ||
usage: docker desktop engine | ||
pname: docker desktop | ||
plink: docker_desktop.yaml | ||
cname: | ||
- docker desktop engine ls | ||
- docker desktop engine use | ||
clink: | ||
- docker_desktop_engine_ls.yaml | ||
- docker_desktop_engine_use.yaml | ||
deprecated: false | ||
hidden: false | ||
experimental: false | ||
experimentalcli: false | ||
kubernetes: false | ||
swarm: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
command: docker desktop engine ls | ||
short: List available engines (Windows only) | ||
usage: docker desktop engine ls | ||
pname: docker desktop engine | ||
plink: docker_desktop_engine.yaml | ||
deprecated: false | ||
hidden: false | ||
experimental: false | ||
experimentalcli: false | ||
kubernetes: false | ||
swarm: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
command: docker desktop engine use | ||
short: Switch to Windows or Linux containers (Windows only) | ||
usage: docker desktop engine use NAME | ||
pname: docker desktop engine | ||
plink: docker_desktop_engine.yaml | ||
deprecated: false | ||
hidden: false | ||
experimental: false | ||
experimentalcli: false | ||
kubernetes: false | ||
swarm: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
command: docker desktop restart | ||
short: Restart Docker Desktop | ||
usage: docker desktop restart | ||
pname: docker desktop | ||
plink: docker_desktop.yaml | ||
deprecated: false | ||
hidden: false | ||
experimental: false | ||
experimentalcli: false | ||
kubernetes: false | ||
swarm: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
command: docker desktop start | ||
short: Start Docker Desktop | ||
usage: docker desktop start [OPTIONS] | ||
pname: docker desktop | ||
plink: docker_desktop.yaml | ||
options: | ||
- option: detach | ||
value_type: bool | ||
default_value: false | ||
description: Start Docker Desktop in the background | ||
deprecated: false | ||
hidden: false | ||
experimental: false | ||
experimentalcli: false | ||
kubernetes: false | ||
swarm: false | ||
- option: timeout | ||
value_type: init | ||
default_value: 0 | ||
description: Specify in seconds how long to wait for Docker Desktop to start before timing out | ||
deprecated: false | ||
hidden: false | ||
experimental: false | ||
experimentalcli: false | ||
kubernetes: false | ||
swarm: false | ||
deprecated: false | ||
hidden: false | ||
experimental: false | ||
experimentalcli: false | ||
kubernetes: false | ||
swarm: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
command: docker desktop status | ||
short: Display Docker Desktop's status | ||
usage: docker desktop status | ||
pname: docker desktop | ||
plink: docker_desktop.yaml | ||
deprecated: false | ||
hidden: false | ||
experimental: false | ||
experimentalcli: false | ||
kubernetes: false | ||
swarm: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
command: docker desktop stop | ||
short: Stop Docker Desktop | ||
usage: docker desktop stop [OPTIONS] | ||
pname: docker desktop | ||
plink: docker_desktop.yaml | ||
options: | ||
- option: detach | ||
value_type: bool | ||
default_value: false | ||
description: Stop Docker Desktop in the background | ||
deprecated: false | ||
hidden: false | ||
experimental: false | ||
experimentalcli: false | ||
kubernetes: false | ||
swarm: false | ||
- option: force | ||
value_type: bool | ||
default_value: false | ||
deprecated: false | ||
hidden: false | ||
experimental: false | ||
experimentalcli: false | ||
kubernetes: false | ||
swarm: false | ||
- option: timeout | ||
value_type: init | ||
default_value: 0 | ||
description: Specify in seconds how long to wait for Docker Desktop to stop before timing out | ||
deprecated: false | ||
hidden: false | ||
experimental: false | ||
experimentalcli: false | ||
kubernetes: false | ||
swarm: false | ||
deprecated: false | ||
hidden: false | ||
experimental: false | ||
experimentalcli: false | ||
kubernetes: false | ||
swarm: false |