Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 4 additions & 1 deletion content/manuals/desktop/features/desktop-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@ docker desktop COMMAND [OPTIONS]
| `engine use` | Switch between Linux and Windows containers (Windows only) |
| `update` | Manage Docker Desktop updates. Available for Mac only with Docker Desktop version 4.38, or all OSs with Docker Desktop version 4.39 and later. |
| `logs` | Print log entries |

| `disable` | Disable a feature |
| `enable` | Enable a feature |
| `version` | Show the Docker Desktop CLI plugin version information |
| `module` | Manage Docker Desktop modules |

For more details on each command, see the [Docker Desktop CLI reference](/reference/cli/docker/desktop/_index.md).
6 changes: 6 additions & 0 deletions content/reference/cli/docker/desktop/disable/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
datafolder: desktop-cli
datafile: docker_desktop_disable
title: docker desktop disable
layout: cli
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
datafolder: desktop-cli
datafile: docker_desktop_disable_model_runner
title: docker desktop disable model-runner
layout: cli
---
6 changes: 6 additions & 0 deletions content/reference/cli/docker/desktop/enable/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
datafolder: desktop-cli
datafile: docker_desktop_enable
title: docker desktop enable
layout: cli
---
6 changes: 6 additions & 0 deletions content/reference/cli/docker/desktop/enable/model-runner.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
datafolder: desktop-cli
datafile: docker_desktop_enable_model_runner
title: docker desktop enable model-runner
layout: cli
---
6 changes: 6 additions & 0 deletions content/reference/cli/docker/desktop/module/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
datafolder: desktop-cli
datafile: docker_desktop_module
title: docker desktop module
layout: cli
---
6 changes: 6 additions & 0 deletions content/reference/cli/docker/desktop/module/ls.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
datafolder: desktop-cli
datafile: docker_desktop_module_ls
title: docker desktop module ls
layout: cli
---
6 changes: 6 additions & 0 deletions content/reference/cli/docker/desktop/module/reset.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
datafolder: desktop-cli
datafile: docker_desktop_module_reset
title: docker desktop reset
layout: cli
---
6 changes: 6 additions & 0 deletions content/reference/cli/docker/desktop/module/update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
datafolder: desktop-cli
datafile: docker_desktop_module_update
title: docker desktop module_update
layout: cli
---
6 changes: 6 additions & 0 deletions content/reference/cli/docker/desktop/version.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
datafolder: desktop-cli
datafile: docker_desktop_version
title: docker desktop version
layout: cli
---
10 changes: 9 additions & 1 deletion data/desktop-cli/docker_desktop.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,23 @@ cname:
- docker desktop status
- docker desktop engine
- docker desktop update
- docker desktop logs
- docker desktop disable
- docker desktop enable
- docker desktop version
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
- docker_desktop_logs.yaml
- docker_desktop_disable.yaml
- docker_desktop_enable.yaml
- docker_desktop_version.yaml
deprecated: false
hidden: false
hidden: true
experimental: false
experimentalcli: false
kubernetes: false
Expand Down
15 changes: 15 additions & 0 deletions data/desktop-cli/docker_desktop_disable.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
command: docker desktop disable
short: Disable a feature
long: Disable an individual feature
pname: docker desktop
plink: docker_desktop.yaml
cname:
- docker desktop disable model-runner
clink:
- docker_desktop_disable_model-runner.yaml
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
12 changes: 12 additions & 0 deletions data/desktop-cli/docker_desktop_disable_model_runner.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
command: docker desktop disable model-runner
short: Disable Docker Model Runner
long: Disable Docker Model Runner
usage: docker desktop disable model-runner
pname: docker desktop disable
plink: docker_desktop_disable.yaml
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
15 changes: 15 additions & 0 deletions data/desktop-cli/docker_desktop_enable.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
command: docker desktop enable
short: Enable a feature
long: Enable or manage an individual feature
pname: docker desktop
plink: docker_desktop.yaml
cname:
- docker desktop enable model-runner
clink:
- docker_desktop_enable_model-runner.yaml
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
34 changes: 34 additions & 0 deletions data/desktop-cli/docker_desktop_enable_model_runner.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
command: docker desktop enable model-runner
short: Manage Docker Model Runner settings
long: Enable and manage Docker Model Runner settings used by 'docker model'
usage: docker desktop enable model-runner [OPTIONS]
pname: docker desktop enable
plink: docker_desktop_enable.yaml
options:
- option: no-tcp
value_type: bool
default_value: "false"
description: Disable TCP connection. Cannot be used with --tcp.
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tcp
value_type: port
default_value: "12434"
description: |
Enable or change TCP port for connection (1-65535). Cannot be used with --no-tcp.
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
11 changes: 11 additions & 0 deletions data/desktop-cli/docker_desktop_engine_ls.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,17 @@ short: List available engines (Windows only)
usage: docker desktop engine ls
pname: docker desktop engine
plink: docker_desktop_engine.yaml
options:
- option: format
value_type: string
default_value: pretty
description: 'Format the output. Accepted values are: pretty, json'
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: false
experimental: false
Expand Down
15 changes: 7 additions & 8 deletions data/desktop-cli/docker_desktop_logs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ plink: docker_desktop.yaml
options:
- option: boot
shorthand: b
value_type: init
default_value: false
value_type: int
default_value: 0
description: Show logs from a specified boot. Zero means the current or boot, one the second last boot, and so on
deprecated: false
hidden: false
Expand Down Expand Up @@ -50,7 +50,7 @@ options:
swarm: false
- option: priority
shorthand: p
value_type: init
value_type: int
default_value: -1
description: Filter output by log priorities. `-1` is all, `0` is info or above, `1` filters for warnings or above, `2` filters for errors.
deprecated: false
Expand All @@ -61,8 +61,7 @@ options:
swarm: false
- option: since
shorthand: S
value_type: bool
default_value: false
value_type: string
description: Start showing entries on or newer than the specified date and time. Uses the systemd.time(7) format.
deprecated: false
hidden: false
Expand All @@ -72,8 +71,8 @@ options:
swarm: false
- option: unit
shorthand: u
value_type: bool
default_value: false
value_type: stringSlice
default_value: '[]'
description: Filter by one or more categories (e.g. `--unit=com.docker.backend.ipc`, `com.docker.backend.apiproxy`)
deprecated: false
hidden: false
Expand All @@ -83,7 +82,7 @@ options:
swarm: false
- option: until
shorthand: U
value_type: bool
value_type: string
default_value: false
description: Start showing entries on or before the specified date and time. Uses the systemd.time(7) format.
deprecated: false
Expand Down
19 changes: 19 additions & 0 deletions data/desktop-cli/docker_desktop_module.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
command: docker desktop module
short: Manage Docker Desktop modules
long: Manage Docker Desktop modules
pname: docker desktop
plink: docker_desktop.yaml
cname:
- docker desktop module ls
- docker desktop module reset
- docker desktop module update
clink:
- docker_desktop_module_ls.yaml
- docker_desktop_module_reset.yaml
- docker_desktop_module_update.yaml
deprecated: false
hidden: true
experimental: false
experimentalcli: true
kubernetes: false
swarm: false
35 changes: 35 additions & 0 deletions data/desktop-cli/docker_desktop_module_ls.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
command: docker desktop module ls
aliases: docker desktop module ls, docker desktop module list
short: List modules
long: List modules
usage: docker desktop module ls
pname: docker desktop module
plink: docker_desktop_module.yaml
options:
- option: format
value_type: string
default_value: pretty
description: 'Format the output. Values: [pretty | json].'
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: quiet
shorthand: q
value_type: bool
default_value: "false"
description: Only display IDs.
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false
12 changes: 12 additions & 0 deletions data/desktop-cli/docker_desktop_module_reset.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
command: docker desktop module reset
short: Reset all updated modules
long: Reset all updated modules
usage: docker desktop module reset
pname: docker desktop module
plink: docker_desktop_module.yaml
deprecated: false
hidden: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false
12 changes: 12 additions & 0 deletions data/desktop-cli/docker_desktop_module_update.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
command: docker desktop module update
short: Update all modules
long: Update all modules
usage: docker desktop module update
pname: docker desktop module
plink: docker_desktop_module.yaml
deprecated: false
hidden: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false
23 changes: 23 additions & 0 deletions data/desktop-cli/docker_desktop_restart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,29 @@ short: Restart Docker Desktop
usage: docker desktop restart
pname: docker desktop
plink: docker_desktop.yaml
options:
- option: detach
shorthand: d
value_type: bool
default_value: "false"
description: Do not synchronously wait for the requested operation to complete.
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: timeout
value_type: seconds
default_value: "0"
description: |
Terminate the running command after the specified timeout with a non-zero exit code. A value of zero (the default) or -1 means no timeout.
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: false
experimental: false
Expand Down
7 changes: 4 additions & 3 deletions data/desktop-cli/docker_desktop_start.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,20 @@ pname: docker desktop
plink: docker_desktop.yaml
options:
- option: detach
shorthand: d
value_type: bool
default_value: false
description: Start Docker Desktop in the background
description: Do not synchronously wait for the requested operation to complete.
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: timeout
value_type: init
value_type: seconds
default_value: 0
description: Specify in seconds how long to wait for Docker Desktop to start before timing out
description: Terminate the running command after the specified timeout with a non-zero exit code. A value of zero (the default) or -1 means no timeout.
deprecated: false
hidden: false
experimental: false
Expand Down
Loading