Skip to content
Closed
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
32 changes: 21 additions & 11 deletions data/desktop-cli/docker_desktop.yaml
Original file line number Diff line number Diff line change
@@ -1,26 +1,36 @@
command: docker desktop
short: Docker Desktop
long: Control Docker Desktop from the CLI
usage: docker desktop
short: Docker Desktop commands (Beta)
long: |-
The Docker Desktop CLI lets you perform key operations such as starting, stopping,
restarting, and updating Docker Desktop directly from the command line.
pname: docker
plink: docker.yaml
cname:
- docker desktop start
- docker desktop stop
- docker desktop disable
- docker desktop enable
- docker desktop engine
- docker desktop logs
- docker desktop restart
- docker desktop start
- docker desktop status
- docker desktop engine
- docker desktop stop
- docker desktop update
- docker desktop version
clink:
- docker_desktop_start.yaml
- docker_desktop_stop.yaml
- docker_desktop_disable.yaml
- docker_desktop_enable.yaml
- docker_desktop_engine.yaml
- docker_desktop_logs.yaml
- docker_desktop_restart.yaml
- docker_desktop_start.yaml
- docker_desktop_status.yaml
- docker_desktop_engine.yaml
- docker_desktop_stop.yaml
- docker_desktop_update.yaml
- docker_desktop_version.yaml
deprecated: false
hidden: false
hidden: true
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
swarm: false

16 changes: 16 additions & 0 deletions data/desktop-cli/docker_desktop_disable.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
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

13 changes: 13 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,13 @@
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

16 changes: 16 additions & 0 deletions data/desktop-cli/docker_desktop_enable.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
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

35 changes: 35 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,35 @@
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

8 changes: 5 additions & 3 deletions data/desktop-cli/docker_desktop_engine.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
command: docker desktop engine
short: Commands to list and switch containers (Windows only)
usage: docker desktop engine
short: Commands to list and switch engine modes (Windows only)
long: Commands to list and switch engine modes (Windows only)
usage: docker desktop engine [command]
pname: docker desktop
plink: docker_desktop.yaml
cname:
Expand All @@ -14,4 +15,5 @@ hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
swarm: false

17 changes: 15 additions & 2 deletions data/desktop-cli/docker_desktop_engine_ls.yaml
Original file line number Diff line number Diff line change
@@ -1,11 +1,24 @@
command: docker desktop engine ls
short: List available engines (Windows only)
short: List available engine modes (Windows only)
long: List available engine modes (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
experimentalcli: false
kubernetes: false
swarm: false
swarm: false

10 changes: 7 additions & 3 deletions data/desktop-cli/docker_desktop_engine_use.yaml
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
command: docker desktop engine use
short: Switch to Windows or Linux containers (Windows only)
usage: docker desktop engine use NAME
short: Switch between Windows and Linux containers (Windows only)
long: |-
Docker Desktop for Windows supports both Windows and Linux containers.
This command lets you switch between Windows and Linux mode from the command line.
usage: docker desktop engine use [MODE]
pname: docker desktop engine
plink: docker_desktop_engine.yaml
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
swarm: false

52 changes: 28 additions & 24 deletions data/desktop-cli/docker_desktop_logs.yaml
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
command: docker desktop logs
short: Print log entries for Docker Desktop
usage: docker desktop logs [OPTIONS]
short: Print log entries
long: Print log entries
usage: docker desktop logs
pname: docker desktop
plink: docker_desktop.yaml
options:
- option: boot
shorthand: b
value_type: init
default_value: false
description: Show logs from a specified boot. Zero means the current or boot, one the second last boot, and so on
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
experimental: false
Expand All @@ -18,7 +20,7 @@ options:
- option: color
shorthand: c
value_type: bool
default_value: false
default_value: "false"
description: Enable colored output. Priority levels are highlighted.
deprecated: false
hidden: false
Expand All @@ -28,9 +30,9 @@ options:
swarm: false
- option: color-mode
shorthand: m
value_type: bool
value_type: string
default_value: default
description: Color mode to use. Can be `default` or `priority`
description: Color mode to use. Can be 'default' or 'priority'
deprecated: false
hidden: false
experimental: false
Expand All @@ -39,9 +41,8 @@ options:
swarm: false
- option: directory
shorthand: D
value_type: bool
default_value: false
description: Specifies a custom directory to search for log entries
value_type: string
description: Specifies a custom directory to search for log entries.
deprecated: false
hidden: false
experimental: false
Expand All @@ -50,9 +51,10 @@ options:
swarm: false
- option: priority
shorthand: p
value_type: init
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.
value_type: int
default_value: "-1"
description: |
Filter output by log priorities. -1 (default) is all, 0 is info or above, 1 warnings or above, 2 errors.
deprecated: false
hidden: false
experimental: false
Expand All @@ -61,9 +63,9 @@ options:
swarm: false
- option: since
shorthand: S
value_type: bool
default_value: false
description: Start showing entries on or newer than the specified date and time. Uses the systemd.time(7) format.
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
experimental: false
Expand All @@ -72,9 +74,10 @@ options:
swarm: false
- option: unit
shorthand: u
value_type: bool
default_value: false
description: Filter by one or more categories (e.g. `--unit=com.docker.backend.ipc`, `com.docker.backend.apiproxy`)
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
experimental: false
Expand All @@ -83,9 +86,9 @@ options:
swarm: false
- option: until
shorthand: U
value_type: bool
default_value: false
description: Start showing entries on or before the specified date and time. Uses the systemd.time(7) format.
value_type: string
description: |
Start showing entries on or before than the specified date and time. Uses the systemd.time(7) format.
deprecated: false
hidden: false
experimental: false
Expand All @@ -97,4 +100,5 @@ hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
swarm: false

20 changes: 20 additions & 0 deletions data/desktop-cli/docker_desktop_module.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
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

36 changes: 36 additions & 0 deletions data/desktop-cli/docker_desktop_module_ls.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
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

13 changes: 13 additions & 0 deletions data/desktop-cli/docker_desktop_module_reset.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
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

Loading