Skip to content

Commit 68ccbee

Browse files
committed
Update desktop-cli docs for v0.1.6
Signed-off-by: Dorin Geman <[email protected]>
1 parent e20141c commit 68ccbee

19 files changed

+343
-65
lines changed
Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,36 @@
11
command: docker desktop
2-
short: Docker Desktop
3-
long: Control Docker Desktop from the CLI
4-
usage: docker desktop
2+
short: Docker Desktop commands (Beta)
3+
long: |-
4+
The Docker Desktop CLI lets you perform key operations such as starting, stopping,
5+
restarting, and updating Docker Desktop directly from the command line.
56
pname: docker
67
plink: docker.yaml
78
cname:
8-
- docker desktop start
9-
- docker desktop stop
9+
- docker desktop disable
10+
- docker desktop enable
11+
- docker desktop engine
12+
- docker desktop logs
1013
- docker desktop restart
14+
- docker desktop start
1115
- docker desktop status
12-
- docker desktop engine
16+
- docker desktop stop
1317
- docker desktop update
18+
- docker desktop version
1419
clink:
15-
- docker_desktop_start.yaml
16-
- docker_desktop_stop.yaml
20+
- docker_desktop_disable.yaml
21+
- docker_desktop_enable.yaml
22+
- docker_desktop_engine.yaml
23+
- docker_desktop_logs.yaml
1724
- docker_desktop_restart.yaml
25+
- docker_desktop_start.yaml
1826
- docker_desktop_status.yaml
19-
- docker_desktop_engine.yaml
27+
- docker_desktop_stop.yaml
2028
- docker_desktop_update.yaml
29+
- docker_desktop_version.yaml
2130
deprecated: false
22-
hidden: false
31+
hidden: true
2332
experimental: false
2433
experimentalcli: false
2534
kubernetes: false
26-
swarm: false
35+
swarm: false
36+
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
command: docker desktop disable
2+
short: Disable a feature
3+
long: Disable an individual feature
4+
pname: docker desktop
5+
plink: docker_desktop.yaml
6+
cname:
7+
- docker desktop disable model-runner
8+
clink:
9+
- docker_desktop_disable_model-runner.yaml
10+
deprecated: false
11+
hidden: false
12+
experimental: false
13+
experimentalcli: false
14+
kubernetes: false
15+
swarm: false
16+
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
command: docker desktop disable model-runner
2+
short: Disable Docker Model Runner
3+
long: Disable Docker Model Runner
4+
usage: docker desktop disable model-runner
5+
pname: docker desktop disable
6+
plink: docker_desktop_disable.yaml
7+
deprecated: false
8+
hidden: false
9+
experimental: false
10+
experimentalcli: false
11+
kubernetes: false
12+
swarm: false
13+
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
command: docker desktop enable
2+
short: Enable a feature
3+
long: Enable or manage an individual feature
4+
pname: docker desktop
5+
plink: docker_desktop.yaml
6+
cname:
7+
- docker desktop enable model-runner
8+
clink:
9+
- docker_desktop_enable_model-runner.yaml
10+
deprecated: false
11+
hidden: false
12+
experimental: false
13+
experimentalcli: false
14+
kubernetes: false
15+
swarm: false
16+
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
command: docker desktop enable model-runner
2+
short: Manage Docker Model Runner settings
3+
long: Enable and manage Docker Model Runner settings used by 'docker model'
4+
usage: docker desktop enable model-runner [OPTIONS]
5+
pname: docker desktop enable
6+
plink: docker_desktop_enable.yaml
7+
options:
8+
- option: no-tcp
9+
value_type: bool
10+
default_value: "false"
11+
description: Disable TCP connection. Cannot be used with --tcp.
12+
deprecated: false
13+
hidden: false
14+
experimental: false
15+
experimentalcli: false
16+
kubernetes: false
17+
swarm: false
18+
- option: tcp
19+
value_type: port
20+
default_value: "12434"
21+
description: |
22+
Enable or change TCP port for connection (1-65535). Cannot be used with --no-tcp.
23+
deprecated: false
24+
hidden: false
25+
experimental: false
26+
experimentalcli: false
27+
kubernetes: false
28+
swarm: false
29+
deprecated: false
30+
hidden: false
31+
experimental: false
32+
experimentalcli: false
33+
kubernetes: false
34+
swarm: false
35+

data/desktop-cli/docker_desktop_engine.yaml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
command: docker desktop engine
2-
short: Commands to list and switch containers (Windows only)
3-
usage: docker desktop engine
2+
short: Commands to list and switch engine modes (Windows only)
3+
long: Commands to list and switch engine modes (Windows only)
4+
usage: docker desktop engine [command]
45
pname: docker desktop
56
plink: docker_desktop.yaml
67
cname:
@@ -14,4 +15,5 @@ hidden: false
1415
experimental: false
1516
experimentalcli: false
1617
kubernetes: false
17-
swarm: false
18+
swarm: false
19+
Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,24 @@
11
command: docker desktop engine ls
2-
short: List available engines (Windows only)
2+
short: List available engine modes (Windows only)
3+
long: List available engine modes (Windows only)
34
usage: docker desktop engine ls
45
pname: docker desktop engine
56
plink: docker_desktop_engine.yaml
7+
options:
8+
- option: format
9+
value_type: string
10+
default_value: pretty
11+
description: 'Format the output. Accepted values are: pretty, json'
12+
deprecated: false
13+
hidden: false
14+
experimental: false
15+
experimentalcli: false
16+
kubernetes: false
17+
swarm: false
618
deprecated: false
719
hidden: false
820
experimental: false
921
experimentalcli: false
1022
kubernetes: false
11-
swarm: false
23+
swarm: false
24+
Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
command: docker desktop engine use
2-
short: Switch to Windows or Linux containers (Windows only)
3-
usage: docker desktop engine use NAME
2+
short: Switch between Windows and Linux containers (Windows only)
3+
long: |-
4+
Docker Desktop for Windows supports both Windows and Linux containers.
5+
This command lets you switch between Windows and Linux mode from the command line.
6+
usage: docker desktop engine use [MODE]
47
pname: docker desktop engine
58
plink: docker_desktop_engine.yaml
69
deprecated: false
710
hidden: false
811
experimental: false
912
experimentalcli: false
1013
kubernetes: false
11-
swarm: false
14+
swarm: false
15+
Lines changed: 28 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
command: docker desktop logs
2-
short: Print log entries for Docker Desktop
3-
usage: docker desktop logs [OPTIONS]
2+
short: Print log entries
3+
long: Print log entries
4+
usage: docker desktop logs
45
pname: docker desktop
56
plink: docker_desktop.yaml
67
options:
78
- option: boot
89
shorthand: b
9-
value_type: init
10-
default_value: false
11-
description: Show logs from a specified boot. Zero means the current or boot, one the second last boot, and so on
10+
value_type: int
11+
default_value: "0"
12+
description: |
13+
Show logs from a specified boot. Zero means the current or boot, one the second last boot, and so on.
1214
deprecated: false
1315
hidden: false
1416
experimental: false
@@ -18,7 +20,7 @@ options:
1820
- option: color
1921
shorthand: c
2022
value_type: bool
21-
default_value: false
23+
default_value: "false"
2224
description: Enable colored output. Priority levels are highlighted.
2325
deprecated: false
2426
hidden: false
@@ -28,9 +30,9 @@ options:
2830
swarm: false
2931
- option: color-mode
3032
shorthand: m
31-
value_type: bool
33+
value_type: string
3234
default_value: default
33-
description: Color mode to use. Can be `default` or `priority`
35+
description: Color mode to use. Can be 'default' or 'priority'
3436
deprecated: false
3537
hidden: false
3638
experimental: false
@@ -39,9 +41,8 @@ options:
3941
swarm: false
4042
- option: directory
4143
shorthand: D
42-
value_type: bool
43-
default_value: false
44-
description: Specifies a custom directory to search for log entries
44+
value_type: string
45+
description: Specifies a custom directory to search for log entries.
4546
deprecated: false
4647
hidden: false
4748
experimental: false
@@ -50,9 +51,10 @@ options:
5051
swarm: false
5152
- option: priority
5253
shorthand: p
53-
value_type: init
54-
default_value: -1
55-
description: Filter output by log priorities. `-1` is all, `0` is info or above, `1` filters for warnings or above, `2` filters for errors.
54+
value_type: int
55+
default_value: "-1"
56+
description: |
57+
Filter output by log priorities. -1 (default) is all, 0 is info or above, 1 warnings or above, 2 errors.
5658
deprecated: false
5759
hidden: false
5860
experimental: false
@@ -61,9 +63,9 @@ options:
6163
swarm: false
6264
- option: since
6365
shorthand: S
64-
value_type: bool
65-
default_value: false
66-
description: Start showing entries on or newer than the specified date and time. Uses the systemd.time(7) format.
66+
value_type: string
67+
description: |
68+
Start showing entries on or newer than the specified date and time. Uses the systemd.time(7) format.
6769
deprecated: false
6870
hidden: false
6971
experimental: false
@@ -72,9 +74,10 @@ options:
7274
swarm: false
7375
- option: unit
7476
shorthand: u
75-
value_type: bool
76-
default_value: false
77-
description: Filter by one or more categories (e.g. `--unit=com.docker.backend.ipc`, `com.docker.backend.apiproxy`)
77+
value_type: stringSlice
78+
default_value: '[]'
79+
description: |
80+
Filter by one or more categories (e.g. --unit=com.docker.backend.ipc,com.docker.backend.apiproxy)
7881
deprecated: false
7982
hidden: false
8083
experimental: false
@@ -83,9 +86,9 @@ options:
8386
swarm: false
8487
- option: until
8588
shorthand: U
86-
value_type: bool
87-
default_value: false
88-
description: Start showing entries on or before the specified date and time. Uses the systemd.time(7) format.
89+
value_type: string
90+
description: |
91+
Start showing entries on or before than the specified date and time. Uses the systemd.time(7) format.
8992
deprecated: false
9093
hidden: false
9194
experimental: false
@@ -97,4 +100,5 @@ hidden: false
97100
experimental: false
98101
experimentalcli: false
99102
kubernetes: false
100-
swarm: false
103+
swarm: false
104+
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
command: docker desktop module
2+
short: Manage Docker Desktop modules
3+
long: Manage Docker Desktop modules
4+
pname: docker desktop
5+
plink: docker_desktop.yaml
6+
cname:
7+
- docker desktop module ls
8+
- docker desktop module reset
9+
- docker desktop module update
10+
clink:
11+
- docker_desktop_module_ls.yaml
12+
- docker_desktop_module_reset.yaml
13+
- docker_desktop_module_update.yaml
14+
deprecated: false
15+
hidden: true
16+
experimental: false
17+
experimentalcli: true
18+
kubernetes: false
19+
swarm: false
20+

0 commit comments

Comments
 (0)