diff --git a/data/desktop-cli/docker_desktop.yaml b/data/desktop-cli/docker_desktop.yaml index 43fe0c765a62..24a0bf174e17 100644 --- a/data/desktop-cli/docker_desktop.yaml +++ b/data/desktop-cli/docker_desktop.yaml @@ -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 \ No newline at end of file +swarm: 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..4ad9a191ddcb --- /dev/null +++ b/data/desktop-cli/docker_desktop_disable.yaml @@ -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 + 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..a4526c84fa2b --- /dev/null +++ b/data/desktop-cli/docker_desktop_disable_model-runner.yaml @@ -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 + diff --git a/data/desktop-cli/docker_desktop_enable.yaml b/data/desktop-cli/docker_desktop_enable.yaml new file mode 100644 index 000000000000..ed638adccc25 --- /dev/null +++ b/data/desktop-cli/docker_desktop_enable.yaml @@ -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 + 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..c78d2c7211a0 --- /dev/null +++ b/data/desktop-cli/docker_desktop_enable_model-runner.yaml @@ -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 + diff --git a/data/desktop-cli/docker_desktop_engine.yaml b/data/desktop-cli/docker_desktop_engine.yaml index 86295164a628..7abae6173303 100644 --- a/data/desktop-cli/docker_desktop_engine.yaml +++ b/data/desktop-cli/docker_desktop_engine.yaml @@ -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: @@ -14,4 +15,5 @@ hidden: false experimental: false experimentalcli: false kubernetes: false -swarm: false \ No newline at end of file +swarm: false + diff --git a/data/desktop-cli/docker_desktop_engine_ls.yaml b/data/desktop-cli/docker_desktop_engine_ls.yaml index 52a1012d06dd..518c6f9cdcf0 100644 --- a/data/desktop-cli/docker_desktop_engine_ls.yaml +++ b/data/desktop-cli/docker_desktop_engine_ls.yaml @@ -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 \ No newline at end of file +swarm: false + diff --git a/data/desktop-cli/docker_desktop_engine_use.yaml b/data/desktop-cli/docker_desktop_engine_use.yaml index e289519506c2..63bb5191ed2f 100644 --- a/data/desktop-cli/docker_desktop_engine_use.yaml +++ b/data/desktop-cli/docker_desktop_engine_use.yaml @@ -1,6 +1,9 @@ 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 @@ -8,4 +11,5 @@ hidden: false experimental: false experimentalcli: false kubernetes: false -swarm: false \ No newline at end of file +swarm: false + diff --git a/data/desktop-cli/docker_desktop_logs.yaml b/data/desktop-cli/docker_desktop_logs.yaml index 2256e52dba13..6ba73349176a 100644 --- a/data/desktop-cli/docker_desktop_logs.yaml +++ b/data/desktop-cli/docker_desktop_logs.yaml @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -97,4 +100,5 @@ hidden: false experimental: false experimentalcli: false kubernetes: false -swarm: false \ No newline at end of file +swarm: 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..44292c5179a7 --- /dev/null +++ b/data/desktop-cli/docker_desktop_module.yaml @@ -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 + 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..ccde8874d722 --- /dev/null +++ b/data/desktop-cli/docker_desktop_module_ls.yaml @@ -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 + 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..bd5273a64cef --- /dev/null +++ b/data/desktop-cli/docker_desktop_module_reset.yaml @@ -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 + 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..4145d4fb2756 --- /dev/null +++ b/data/desktop-cli/docker_desktop_module_update.yaml @@ -0,0 +1,13 @@ +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 + diff --git a/data/desktop-cli/docker_desktop_restart.yaml b/data/desktop-cli/docker_desktop_restart.yaml index 4809ede15448..c4bdc2fcf6b7 100644 --- a/data/desktop-cli/docker_desktop_restart.yaml +++ b/data/desktop-cli/docker_desktop_restart.yaml @@ -1,11 +1,36 @@ command: docker desktop restart short: Restart Docker Desktop +long: 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 experimentalcli: false kubernetes: false -swarm: false \ No newline at end of file +swarm: false + diff --git a/data/desktop-cli/docker_desktop_start.yaml b/data/desktop-cli/docker_desktop_start.yaml index 3422aa8873d2..7ecd2f54ced7 100644 --- a/data/desktop-cli/docker_desktop_start.yaml +++ b/data/desktop-cli/docker_desktop_start.yaml @@ -1,13 +1,15 @@ command: docker desktop start short: Start Docker Desktop -usage: docker desktop start [OPTIONS] +long: Start Docker Desktop +usage: docker desktop start 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 + default_value: "false" + description: Do not synchronously wait for the requested operation to complete. deprecated: false hidden: false experimental: false @@ -15,9 +17,10 @@ options: 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 + 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 @@ -30,3 +33,4 @@ experimental: false experimentalcli: false kubernetes: false swarm: false + diff --git a/data/desktop-cli/docker_desktop_status.yaml b/data/desktop-cli/docker_desktop_status.yaml index e69a46a6e17d..def3b68c23dc 100644 --- a/data/desktop-cli/docker_desktop_status.yaml +++ b/data/desktop-cli/docker_desktop_status.yaml @@ -1,11 +1,24 @@ command: docker desktop status -short: Display Docker Desktop's status +short: Show the status of the Docker Desktop engines +long: Show the status of the Docker Desktop engines 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 experimentalcli: false kubernetes: false -swarm: false \ No newline at end of file +swarm: false + diff --git a/data/desktop-cli/docker_desktop_stop.yaml b/data/desktop-cli/docker_desktop_stop.yaml index e0b775a4e6f2..1672aa92d54f 100644 --- a/data/desktop-cli/docker_desktop_stop.yaml +++ b/data/desktop-cli/docker_desktop_stop.yaml @@ -1,13 +1,15 @@ command: docker desktop stop short: Stop Docker Desktop -usage: docker desktop stop [OPTIONS] +long: Stop Docker Desktop +usage: docker desktop stop 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 + default_value: "false" + description: Do not synchronously wait for the requested operation to complete. deprecated: false hidden: false experimental: false @@ -16,7 +18,8 @@ options: swarm: false - option: force value_type: bool - default_value: false + default_value: "false" + description: Force Docker Desktop to stop deprecated: false hidden: false experimental: false @@ -24,9 +27,10 @@ options: 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 + 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 @@ -38,4 +42,5 @@ hidden: false experimental: false experimentalcli: false kubernetes: false -swarm: false \ No newline at end of file +swarm: false + diff --git a/data/desktop-cli/docker_desktop_update.yaml b/data/desktop-cli/docker_desktop_update.yaml index ab659d47e832..269ca0c70c45 100644 --- a/data/desktop-cli/docker_desktop_update.yaml +++ b/data/desktop-cli/docker_desktop_update.yaml @@ -1,13 +1,14 @@ command: docker desktop update short: Manage Docker Desktop updates -usage: docker desktop update [OPTIONS] +long: Manage Docker Desktop updates +usage: docker desktop update pname: docker desktop plink: docker_desktop.yaml options: - option: check-only shorthand: k value_type: bool - default_value: false + default_value: "false" description: Check for updates without applying them deprecated: false hidden: false @@ -18,8 +19,8 @@ options: - option: quiet shorthand: q value_type: bool - default_value: false - description: Queitly check and apply updates + default_value: "false" + description: Quietly check and apply updates deprecated: false hidden: false experimental: false @@ -31,4 +32,5 @@ hidden: false experimental: false experimentalcli: false kubernetes: false -swarm: false \ No newline at end of file +swarm: 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..6666b360dccb --- /dev/null +++ b/data/desktop-cli/docker_desktop_version.yaml @@ -0,0 +1,34 @@ +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 +