Skip to content

Commit 9af688c

Browse files
committed
docs: add manifest inspect command reference
Documented the nerdctl manifest inspect command with usage, flags, and examples. Signed-off-by: ChengyuZhu6 <[email protected]>
1 parent 34f583f commit 9af688c

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

docs/command-reference.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,8 @@ It does not necessarily mean that the corresponding features are missing in cont
5151
- [:nerd_face: nerdctl image convert](#nerd_face-nerdctl-image-convert)
5252
- [:nerd_face: nerdctl image encrypt](#nerd_face-nerdctl-image-encrypt)
5353
- [:nerd_face: nerdctl image decrypt](#nerd_face-nerdctl-image-decrypt)
54+
- [Manifest management](#manifest-management)
55+
- [:nerd\_face: nerdctl manifest inspect](#nerd_face-nerdctl-manifest-inspect)
5456
- [Registry](#registry)
5557
- [:whale: nerdctl login](#whale-nerdctl-login)
5658
- [:whale: nerdctl logout](#whale-nerdctl-logout)
@@ -1035,6 +1037,37 @@ Flags:
10351037
- `--platform=<PLATFORM>` : Convert content for a specific platform
10361038
- `--all-platforms` : Convert content for all platforms (default: false)
10371039

1040+
## Manifest management
1041+
1042+
### :nerd_face: nerdctl manifest inspect
1043+
1044+
Display the contents of a manifest list or manifest.
1045+
1046+
Usage: `nerdctl manifest inspect [OPTIONS] MANIFEST`
1047+
1048+
#### Input formats
1049+
1050+
You can specify the manifest to inspect using one of the following formats:
1051+
- **Image name with tag**: `alpine:3.22.1`
1052+
- **Digest with sha256 prefix**: `sha256:eafc1edb577d2e9b458664a15f23ea1c370214193226069eb22921169fc7e43f`
1053+
- **Image name with digest**: `alpine@sha256:eafc1edb577d2e9b458664a15f23ea1c370214193226069eb22921169fc7e43f`
1054+
1055+
Flags:
1056+
1057+
- `--verbose` : Verbose output, show additional info including layers and platform
1058+
1059+
Example:
1060+
1061+
```bash
1062+
nerdctl manifest inspect alpine:3.22.1
1063+
nerdctl manifest inspect sha256:eafc1edb577d2e9b458664a15f23ea1c370214193226069eb22921169fc7e43f
1064+
nerdctl manifest inspect alpine@sha256:eafc1edb577d2e9b458664a15f23ea1c370214193226069eb22921169fc7e43f
1065+
```
1066+
1067+
Notes:
1068+
- The default output is JSON.
1069+
- Currently, only manifests of images that already exist locally can be inspected. Remote images are not supported.
1070+
10381071
## Registry
10391072

10401073
### :whale: nerdctl login

0 commit comments

Comments
 (0)