@@ -96,7 +96,7 @@ See [`./docs/freebsd.md`](docs/freebsd.md).
96
96
### Windows
97
97
98
98
- Linux containers: Known to work on WSL2
99
- - Windows containers: WIP, see [ PR # 197 ] ( https://github.com/containerd/nerdctl/pull/197 )
99
+ - Windows containers: experimental support for Windows (see below for features that are currently known to work )
100
100
101
101
### Docker
102
102
@@ -194,6 +194,8 @@ Please certify your [Developer Certificate of Origin (DCO)](https://developercer
194
194
195
195
:nerd_face : = nerdctl specific
196
196
197
+ :window : = Windows enabled
198
+
197
199
Unlisted ` docker ` CLI flags are unimplemented yet in ` nerdctl ` CLI.
198
200
It does not necessarily mean that the corresponding features are missing in containerd.
199
201
@@ -202,10 +204,10 @@ It does not necessarily mean that the corresponding features are missing in cont
202
204
203
205
204
206
- [ Run & Exec] ( #run--exec )
205
- - [ :whale : nerdctl run] ( #whale-nerdctl-run )
206
- - [ :whale : nerdctl exec] ( #whale-nerdctl-exec )
207
+ - [ :whale : : window : nerdctl run] ( #whale-nerdctl-run )
208
+ - [ :whale : : window : nerdctl exec] ( #whale-nerdctl-exec )
207
209
- [ Container management] ( #container-management )
208
- - [ :whale : nerdctl ps] ( #whale-nerdctl-ps )
210
+ - [ :whale : : window : nerdctl ps] ( #whale-nerdctl-ps )
209
211
- [ :whale : nerdctl inspect] ( #whale-nerdctl-inspect )
210
212
- [ :whale : nerdctl logs] ( #whale-nerdctl-logs )
211
213
- [ :whale : nerdctl port] ( #whale-nerdctl-port )
@@ -221,8 +223,8 @@ It does not necessarily mean that the corresponding features are missing in cont
221
223
- [ :whale : nerdctl build] ( #whale-nerdctl-build )
222
224
- [ :whale : nerdctl commit] ( #whale-nerdctl-commit )
223
225
- [ Image management] ( #image-management )
224
- - [ :whale : nerdctl images] ( #whale-nerdctl-images )
225
- - [ :whale : nerdctl pull] ( #whale-nerdctl-pull )
226
+ - [ :whale : : window : nerdctl images] ( #whale-nerdctl-images )
227
+ - [ :whale : : window : nerdctl pull] ( #whale-nerdctl-pull )
226
228
- [ :whale : nerdctl push] ( #whale-nerdctl-push )
227
229
- [ :whale : nerdctl load] ( #whale-nerdctl-load )
228
230
- [ :whale : nerdctl save] ( #whale-nerdctl-save )
@@ -246,7 +248,7 @@ It does not necessarily mean that the corresponding features are missing in cont
246
248
- [ :whale : nerdctl volume inspect] ( #whale-nerdctl-volume-inspect )
247
249
- [ :whale : nerdctl volume rm] ( #whale-nerdctl-volume-rm )
248
250
- [ Namespace management] ( #namespace-management )
249
- - [ :nerd_face : nerdctl namespace ls] ( #nerd_face-nerdctl-namespace-ls )
251
+ - [ :nerd_face : : window : nerdctl namespace ls] ( #nerd_face-nerdctl-namespace-ls )
250
252
- [ System] ( #system )
251
253
- [ :whale : nerdctl events] ( #whale-nerdctl-events )
252
254
- [ :whale : nerdctl info] ( #whale-nerdctl-info )
@@ -280,10 +282,10 @@ Run a command in a new container.
280
282
Usage: ` nerdctl run [OPTIONS] IMAGE [COMMAND] [ARG...] `
281
283
282
284
Basic flags:
283
- - :whale : ` -i, --interactive ` : Keep STDIN open even if not attached"
284
- - :whale : ` -t, --tty ` : Allocate a pseudo-TTY
285
+ - :whale : : window : ` -i, --interactive ` : Keep STDIN open even if not attached"
286
+ - :whale : : window : ` -t, --tty ` : Allocate a pseudo-TTY
285
287
- :warning : WIP: currently ` -t ` requires ` -i ` , and conflicts with ` -d `
286
- - :whale : ` -d, --detach ` : Run container in background and print container ID
288
+ - :whale : : window : ` -d, --detach ` : Run container in background and print container ID
287
289
- :whale : ` --restart=(no|always) ` : Restart policy to apply when a container exits
288
290
- Default: "no"
289
291
- :warning : No support for ` on-failure ` and ` unless-stopped `
@@ -317,7 +319,7 @@ Cgroup flags:
317
319
- :whale : ` --device ` : Add a host device to the container
318
320
319
321
User flags:
320
- - :whale : ` -u, --user ` : Username or UID (format: <name|uid>[ :<group|gid>] )
322
+ - :whale : : window : ` -u, --user ` : Username or UID (format: <name|uid>[ :<group|gid>] )
321
323
322
324
Security flags:
323
325
- :whale : ` --security-opt seccomp=<PROFILE_JSON_FILE> ` : specify custom seccomp profile
@@ -332,7 +334,7 @@ Runtime flags:
332
334
- :whale : ` --sysctl ` : Sysctl options, e.g \" net.ipv4.ip_forward=1\"
333
335
334
336
Volume flags:
335
- - :whale : ` -v, --volume ` : Bind mount a volume
337
+ - :whale : : window : ` -v, --volume ` : Bind mount a volume
336
338
- :whale : ` --tmpfs ` : Mount a tmpfs directory
337
339
338
340
Rootfs flags:
@@ -341,16 +343,16 @@ Rootfs flags:
341
343
Corresponds to Podman CLI.
342
344
343
345
Env flags:
344
- - :whale : ` --entrypoint ` : Overwrite the default ENTRYPOINT of the image
345
- - :whale : ` -w, --workdir ` : Working directory inside the container
346
- - :whale : ` -e, --env ` : Set environment variables
347
- - :whale : ` --env-file ` : Set environment variables from file
346
+ - :whale : : window : ` --entrypoint ` : Overwrite the default ENTRYPOINT of the image
347
+ - :whale : : window : ` -w, --workdir ` : Working directory inside the container
348
+ - :whale : : window : ` -e, --env ` : Set environment variables
349
+ - :whale : : window : ` --env-file ` : Set environment variables from file
348
350
349
351
Metadata flags:
350
- - :whale : ` --name ` : Assign a name to the container
351
- - :whale : ` -l, --label ` : Set meta data on a container
352
- - :whale : ` --label-file ` : Read in a line delimited file of labels
353
- - :whale : ` --cidfile ` : Write the container ID to the file
352
+ - :whale : : window : ` --name ` : Assign a name to the container
353
+ - :whale : : window : ` -l, --label ` : Set meta data on a container
354
+ - :whale : : window : ` --label-file ` : Read in a line delimited file of labels
355
+ - :whale : : window : ` --cidfile ` : Write the container ID to the file
354
356
- :nerd_face : ` --pidfile ` : file path to write the task's pid. The CLI syntax conforms to Podman convention.
355
357
356
358
Shared memory flags:
@@ -480,7 +482,7 @@ Options:
480
482
481
483
</details >
482
484
483
- ### :whale : nerdctl exec
485
+ ### :whale : : window : nerdctl exec
484
486
Run a command in a running container.
485
487
486
488
Usage: ` nerdctl exec [OPTIONS] CONTAINER COMMAND [ARG...] `
@@ -511,7 +513,7 @@ Flags:
511
513
512
514
Unimplemented ` docker ps ` flags: ` --filter ` , ` --last ` , ` --size `
513
515
514
- ### :whale : nerdctl inspect
516
+ ### :whale : : window : nerdctl inspect
515
517
Display detailed information on one or more containers.
516
518
517
519
Usage: ` nerdctl inspect [OPTIONS] NAME|ID [NAME|ID...] `
@@ -895,7 +897,7 @@ Usage: `nerdctl volume rm [OPTIONS] VOLUME [VOLUME...]`
895
897
896
898
## Namespace management
897
899
898
- ### :nerd_face : nerdctl namespace ls
900
+ ### :nerd_face : : window : nerdctl namespace ls
899
901
List containerd namespaces such as "default", "moby", or "k8s.io".
900
902
901
903
Usage: ` nerdctl namespace ls [OPTIONS] `
@@ -1039,13 +1041,13 @@ Unimplemented `docker-compose ps` (V1) flags: `--quiet`, `--services`, `--filter
1039
1041
Unimplemented ` docker compose ps ` (V2) flags: ` --format ` , ` --status `
1040
1042
1041
1043
## Global flags
1042
- - :nerd_face : ` -a ` , ` --address ` : containerd address, optionally with "unix://" prefix
1044
+ - :nerd_face : : window : ` -a ` , ` --address ` : containerd address, optionally with "unix://" prefix
1043
1045
- :whale : ` -H ` , ` --host ` : Docker-compatible alias for ` -a ` , ` --address `
1044
- - :nerd_face : ` -n ` , ` --namespace ` : containerd namespace
1045
- - :nerd_face : ` --snapshotter ` : containerd snapshotter
1046
- - :nerd_face : ` --cni-path ` : CNI binary path (default: ` /opt/cni/bin ` ) [ ` $CNI_PATH ` ]
1047
- - :nerd_face : ` --cni-netconfpath ` : CNI netconf path (default: ` /etc/cni/net.d ` ) [ ` $NETCONFPATH ` ]
1048
- - :nerd_face : ` --data-root ` : nerdctl data root, e.g. "/var/lib/nerdctl"
1046
+ - :nerd_face : : window : ` -n ` , ` --namespace ` : containerd namespace
1047
+ - :nerd_face : : window : ` --snapshotter ` : containerd snapshotter
1048
+ - :nerd_face : : window : ` --cni-path ` : CNI binary path (default: ` /opt/cni/bin ` ) [ ` $CNI_PATH ` ]
1049
+ - :nerd_face : : window : ` --cni-netconfpath ` : CNI netconf path (default: ` /etc/cni/net.d ` ) [ ` $NETCONFPATH ` ]
1050
+ - :nerd_face : : window : ` --data-root ` : nerdctl data root, e.g. "/var/lib/nerdctl"
1049
1051
- :nerd_face : ` --cgroup-manager=(cgroupfs|systemd|none) ` : cgroup manager
1050
1052
- Default: "systemd" on cgroup v2 (rootful & rootless), "cgroupfs" on v1 rootful, "none" on v1 rootless
1051
1053
- :nerd_face : ` --insecure-registry ` : skips verifying HTTPS certs, and allows falling back to plain HTTP
0 commit comments