diff --git a/content/manuals/desktop/features/desktop-cli.md b/content/manuals/desktop/features/desktop-cli.md index b065de091aa8..600224a500df 100644 --- a/content/manuals/desktop/features/desktop-cli.md +++ b/content/manuals/desktop/features/desktop-cli.md @@ -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). diff --git a/content/reference/cli/docker/desktop/disable/_index.md b/content/reference/cli/docker/desktop/disable/_index.md new file mode 100644 index 000000000000..74a81e6c355e --- /dev/null +++ b/content/reference/cli/docker/desktop/disable/_index.md @@ -0,0 +1,6 @@ +--- +datafolder: desktop-cli +datafile: docker_desktop_disable +title: docker desktop disable +layout: cli +--- \ No newline at end of file diff --git a/content/reference/cli/docker/desktop/disable/model-runner.md b/content/reference/cli/docker/desktop/disable/model-runner.md new file mode 100644 index 000000000000..40a825ee10fd --- /dev/null +++ b/content/reference/cli/docker/desktop/disable/model-runner.md @@ -0,0 +1,6 @@ +--- +datafolder: desktop-cli +datafile: docker_desktop_disable_model_runner +title: docker desktop disable model-runner +layout: cli +--- \ No newline at end of file diff --git a/content/reference/cli/docker/desktop/enable/_index.md b/content/reference/cli/docker/desktop/enable/_index.md new file mode 100644 index 000000000000..f1213c9c8d2f --- /dev/null +++ b/content/reference/cli/docker/desktop/enable/_index.md @@ -0,0 +1,6 @@ +--- +datafolder: desktop-cli +datafile: docker_desktop_enable +title: docker desktop enable +layout: cli +--- \ No newline at end of file diff --git a/content/reference/cli/docker/desktop/enable/model-runner.md b/content/reference/cli/docker/desktop/enable/model-runner.md new file mode 100644 index 000000000000..6ffbb9c21792 --- /dev/null +++ b/content/reference/cli/docker/desktop/enable/model-runner.md @@ -0,0 +1,6 @@ +--- +datafolder: desktop-cli +datafile: docker_desktop_enable_model_runner +title: docker desktop enable model-runner +layout: cli +--- \ No newline at end of file diff --git a/content/reference/cli/docker/desktop/module/_index.md b/content/reference/cli/docker/desktop/module/_index.md new file mode 100644 index 000000000000..88f9fc9266f7 --- /dev/null +++ b/content/reference/cli/docker/desktop/module/_index.md @@ -0,0 +1,6 @@ +--- +datafolder: desktop-cli +datafile: docker_desktop_module +title: docker desktop module +layout: cli +--- \ No newline at end of file diff --git a/content/reference/cli/docker/desktop/module/ls.md b/content/reference/cli/docker/desktop/module/ls.md new file mode 100644 index 000000000000..cb9dec4e7074 --- /dev/null +++ b/content/reference/cli/docker/desktop/module/ls.md @@ -0,0 +1,6 @@ +--- +datafolder: desktop-cli +datafile: docker_desktop_module_ls +title: docker desktop module ls +layout: cli +--- \ No newline at end of file diff --git a/content/reference/cli/docker/desktop/module/reset.md b/content/reference/cli/docker/desktop/module/reset.md new file mode 100644 index 000000000000..d9de96ebb514 --- /dev/null +++ b/content/reference/cli/docker/desktop/module/reset.md @@ -0,0 +1,6 @@ +--- +datafolder: desktop-cli +datafile: docker_desktop_module_reset +title: docker desktop reset +layout: cli +--- \ No newline at end of file diff --git a/content/reference/cli/docker/desktop/module/update.md b/content/reference/cli/docker/desktop/module/update.md new file mode 100644 index 000000000000..e57056863d21 --- /dev/null +++ b/content/reference/cli/docker/desktop/module/update.md @@ -0,0 +1,6 @@ +--- +datafolder: desktop-cli +datafile: docker_desktop_module_update +title: docker desktop module_update +layout: cli +--- \ No newline at end of file diff --git a/content/reference/cli/docker/desktop/version.md b/content/reference/cli/docker/desktop/version.md new file mode 100644 index 000000000000..26a5c856198a --- /dev/null +++ b/content/reference/cli/docker/desktop/version.md @@ -0,0 +1,6 @@ +--- +datafolder: desktop-cli +datafile: docker_desktop_version +title: docker desktop version +layout: cli +--- \ No newline at end of file diff --git a/data/desktop-cli/docker_desktop.yaml b/data/desktop-cli/docker_desktop.yaml index 43fe0c765a62..f65ec5666d19 100644 --- a/data/desktop-cli/docker_desktop.yaml +++ b/data/desktop-cli/docker_desktop.yaml @@ -11,6 +11,10 @@ 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 @@ -18,8 +22,12 @@ clink: - 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 diff --git a/data/desktop-cli/docker_desktop_disable.yaml b/data/desktop-cli/docker_desktop_disable.yaml new file mode 100644 index 000000000000..5cfb99f7e210 --- /dev/null +++ b/data/desktop-cli/docker_desktop_disable.yaml @@ -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 \ No newline at end of file diff --git a/data/desktop-cli/docker_desktop_disable_model_runner.yaml b/data/desktop-cli/docker_desktop_disable_model_runner.yaml new file mode 100644 index 000000000000..c7505e41cb56 --- /dev/null +++ b/data/desktop-cli/docker_desktop_disable_model_runner.yaml @@ -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 \ No newline at end of file diff --git a/data/desktop-cli/docker_desktop_enable.yaml b/data/desktop-cli/docker_desktop_enable.yaml new file mode 100644 index 000000000000..d03f463a7dc9 --- /dev/null +++ b/data/desktop-cli/docker_desktop_enable.yaml @@ -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 \ No newline at end of file diff --git a/data/desktop-cli/docker_desktop_enable_model_runner.yaml b/data/desktop-cli/docker_desktop_enable_model_runner.yaml new file mode 100644 index 000000000000..4e163b0a4298 --- /dev/null +++ b/data/desktop-cli/docker_desktop_enable_model_runner.yaml @@ -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 \ No newline at end of file diff --git a/data/desktop-cli/docker_desktop_engine_ls.yaml b/data/desktop-cli/docker_desktop_engine_ls.yaml index 52a1012d06dd..3c64229e6287 100644 --- a/data/desktop-cli/docker_desktop_engine_ls.yaml +++ b/data/desktop-cli/docker_desktop_engine_ls.yaml @@ -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 diff --git a/data/desktop-cli/docker_desktop_logs.yaml b/data/desktop-cli/docker_desktop_logs.yaml index 2256e52dba13..3b447555e47d 100644 --- a/data/desktop-cli/docker_desktop_logs.yaml +++ b/data/desktop-cli/docker_desktop_logs.yaml @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 diff --git a/data/desktop-cli/docker_desktop_module.yaml b/data/desktop-cli/docker_desktop_module.yaml new file mode 100644 index 000000000000..4e044778be32 --- /dev/null +++ b/data/desktop-cli/docker_desktop_module.yaml @@ -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 \ No newline at end of file diff --git a/data/desktop-cli/docker_desktop_module_ls.yaml b/data/desktop-cli/docker_desktop_module_ls.yaml new file mode 100644 index 000000000000..953cd1cce793 --- /dev/null +++ b/data/desktop-cli/docker_desktop_module_ls.yaml @@ -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 \ No newline at end of file diff --git a/data/desktop-cli/docker_desktop_module_reset.yaml b/data/desktop-cli/docker_desktop_module_reset.yaml new file mode 100644 index 000000000000..f3fdc72b97c1 --- /dev/null +++ b/data/desktop-cli/docker_desktop_module_reset.yaml @@ -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 \ No newline at end of file diff --git a/data/desktop-cli/docker_desktop_module_update.yaml b/data/desktop-cli/docker_desktop_module_update.yaml new file mode 100644 index 000000000000..2013c51d5e32 --- /dev/null +++ b/data/desktop-cli/docker_desktop_module_update.yaml @@ -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 \ No newline at end of file diff --git a/data/desktop-cli/docker_desktop_restart.yaml b/data/desktop-cli/docker_desktop_restart.yaml index 4809ede15448..62653e3d4bad 100644 --- a/data/desktop-cli/docker_desktop_restart.yaml +++ b/data/desktop-cli/docker_desktop_restart.yaml @@ -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 diff --git a/data/desktop-cli/docker_desktop_start.yaml b/data/desktop-cli/docker_desktop_start.yaml index 3422aa8873d2..95413bef75c1 100644 --- a/data/desktop-cli/docker_desktop_start.yaml +++ b/data/desktop-cli/docker_desktop_start.yaml @@ -5,9 +5,10 @@ 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 @@ -15,9 +16,9 @@ options: 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 diff --git a/data/desktop-cli/docker_desktop_status.yaml b/data/desktop-cli/docker_desktop_status.yaml index e69a46a6e17d..85afef084e73 100644 --- a/data/desktop-cli/docker_desktop_status.yaml +++ b/data/desktop-cli/docker_desktop_status.yaml @@ -3,6 +3,17 @@ short: Display Docker Desktop's status usage: docker desktop status pname: docker desktop plink: docker_desktop.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 diff --git a/data/desktop-cli/docker_desktop_stop.yaml b/data/desktop-cli/docker_desktop_stop.yaml index e0b775a4e6f2..98d0ff7e12e6 100644 --- a/data/desktop-cli/docker_desktop_stop.yaml +++ b/data/desktop-cli/docker_desktop_stop.yaml @@ -5,9 +5,10 @@ pname: docker desktop plink: docker_desktop.yaml options: - option: detach + shorthand: d value_type: bool default_value: false - description: Stop Docker Desktop in the background + description: Do not synchronously wait for the requested operation to complete deprecated: false hidden: false experimental: false @@ -17,6 +18,7 @@ options: - option: force value_type: bool default_value: false + description: Force Docker Desktop to stop deprecated: false hidden: false experimental: false @@ -24,9 +26,9 @@ options: 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 stop 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 diff --git a/data/desktop-cli/docker_desktop_update.yaml b/data/desktop-cli/docker_desktop_update.yaml index ab659d47e832..aa50cdcef118 100644 --- a/data/desktop-cli/docker_desktop_update.yaml +++ b/data/desktop-cli/docker_desktop_update.yaml @@ -19,7 +19,7 @@ options: shorthand: q value_type: bool default_value: false - description: Queitly check and apply updates + description: Quietly check and apply updates deprecated: false hidden: false experimental: false diff --git a/data/desktop-cli/docker_desktop_version.yaml b/data/desktop-cli/docker_desktop_version.yaml new file mode 100644 index 000000000000..d52f6315ced9 --- /dev/null +++ b/data/desktop-cli/docker_desktop_version.yaml @@ -0,0 +1,33 @@ +command: docker desktop version +short: Show the Docker Desktop CLI plugin version information +long: Show the Docker Desktop CLI plugin version information +usage: docker desktop version [OPTIONS] +pname: docker desktop +plink: docker_desktop.yaml +options: + - option: format + shorthand: f + value_type: string + description: 'Format the output. Values: [pretty | json]. (Default: pretty)' + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false + - option: short + value_type: bool + default_value: "false" + description: Shows only the version number + deprecated: false + hidden: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +deprecated: false +hidden: false +experimental: false +experimentalcli: false +kubernetes: false +swarm: false \ No newline at end of file