-
Notifications
You must be signed in to change notification settings - Fork 7.4k
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.
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
ENGDOCS-2342 #21573
base: main
Are you sure you want to change the base?
ENGDOCS-2342 #21573
Changes from 5 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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. | ||
Check warning on line 22 in content/manuals/desktop/features/desktop-cli.md GitHub Actions / vale
Check warning on line 22 in content/manuals/desktop/features/desktop-cli.md GitHub Actions / vale
|
||
- 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). |
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 %}} |
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 | ||
--- |
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 | ||
--- |
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 | ||
--- |
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 | ||
--- |
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @Xeeynamo does If not we should mention it. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
datafolder: desktop-cli | ||
datafile: docker_desktop_start | ||
title: docker desktop start | ||
layout: cli | ||
--- |
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 | ||
--- |
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 | ||
--- |
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 |
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 |
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 |
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 |
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 | ||
aevesdocker marked this conversation as resolved.
Show resolved
Hide resolved
|
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: stringArray | ||
default_value: '[]' | ||
aevesdocker marked this conversation as resolved.
Show resolved
Hide resolved
|
||
description: Start Docker Desktop in the background | ||
deprecated: false | ||
hidden: false | ||
experimental: false | ||
experimentalcli: false | ||
kubernetes: false | ||
swarm: false | ||
- option: timeout | ||
value_type: string | ||
default_value: '[]' | ||
aevesdocker marked this conversation as resolved.
Show resolved
Hide resolved
|
||
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 |
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 |
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: stringArray | ||||||||||
default_value: '[]' | ||||||||||
aevesdocker marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||
description: Start Docker Desktop in the background | ||||||||||
aevesdocker marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||
deprecated: false | ||||||||||
hidden: false | ||||||||||
experimental: false | ||||||||||
experimentalcli: false | ||||||||||
kubernetes: false | ||||||||||
swarm: false | ||||||||||
- option: force | ||||||||||
value_type: stringArray | ||||||||||
default_value: '[]' | ||||||||||
aevesdocker marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||
deprecated: false | ||||||||||
hidden: false | ||||||||||
experimental: false | ||||||||||
experimentalcli: false | ||||||||||
kubernetes: false | ||||||||||
swarm: false | ||||||||||
- option: timeout | ||||||||||
value_type: string | ||||||||||
default_value: '[]' | ||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
description: Specify in seconds how long to wait for Docker Desktop to start before timing out | ||||||||||
aevesdocker marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||
deprecated: false | ||||||||||
hidden: false | ||||||||||
experimental: false | ||||||||||
experimentalcli: false | ||||||||||
kubernetes: false | ||||||||||
swarm: false | ||||||||||
deprecated: false | ||||||||||
aevesdocker marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||
hidden: false | ||||||||||
experimental: false | ||||||||||
experimentalcli: false | ||||||||||
kubernetes: false | ||||||||||
swarm: false |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Who in their right mind would use Docker Desktop in CI?