1SKOPEO(1)(Skopeo) SKOPEO(1)(Skopeo)
2
3
4
5Jhon Honce August 2016
6
8 skopeo -- Command line utility used to interact with local and remote
9 container images and container image registries
10
11
13 skopeo [global options] command [command options]
14
15
17 skopeo is a command line utility providing various operations with con‐
18 tainer images and container image registries.
19
20
21 skopeo can copy container images between various containers image
22 stores, converting them as necessary. For example you can use skopeo
23 to copy container images from one container registry to another.
24
25
26 skopeo can convert a Docker schema 2 or schema 1 container image to an
27 OCI image.
28
29
30 skopeo can inspect a repository on a container registry without need‐
31 lessly pulling the image. Pulling an image from a repository, espe‐
32 cially a remote repository, is an expensive network and storage opera‐
33 tion. Skopeo fetches the repository's manifest and displays a docker
34 inspect-like json output about the repository or a tag. skopeo, in con‐
35 trast to docker inspect, helps you gather useful information about a
36 repository or a tag without requiring you to run docker pull - e.g. -
37 Which tags are available for the given repository? Which labels does
38 the image have?
39
40
41 skopeo can sign and verify container images.
42
43
44 skopeo can delete container images from a remote container registry.
45
46
47 Note: skopeo does not require any container runtimes to be running, to
48 do most of its functionality. It also does not require root, unless
49 you are copying images into a container runtime storage backend, like
50 the docker daemon or github.com/containers/storage.
51
52
54 Most commands refer to container images, using a transport:details for‐
55 mat. The following formats are supported:
56
57
58 containers-storage:docker-reference
59 An image located in a local containers/storage image store. Both the
60 location and image store are specified in /etc/containers/storage.conf.
61 (Backend for Podman, CRI-O, Buildah and friends)
62
63
64 dir:path
65 An existing local directory path storing the manifest, layer tarballs
66 and signatures as individual files. This is a non-standardized format,
67 primarily useful for debugging or noninvasive container inspection.
68
69
70 docker://docker-reference
71 An image in a registry implementing the "Docker Registry HTTP API
72 V2". By default, uses the authorization state in either $XDG_RUN‐
73 TIME_DIR/containers/auth.json, which is set using (skopeo login). If
74 the authorization state is not found there, $HOME/.docker/config.json
75 is checked, which is set using (docker login).
76
77
78 docker-archive:path[:docker-reference]
79 An image is stored in the docker save formatted file. docker-refer‐
80 ence is only used when creating such a file, and it must not contain a
81 digest.
82
83
84 docker-daemon:docker-reference
85 An image docker-reference stored in the docker daemon internal stor‐
86 age. docker-reference must contain either a tag or a digest. Alterna‐
87 tively, when reading images, the format can be docker-dae‐
88 mon:algo:digest (an image ID).
89
90
91 oci:path:tag
92 An image tag in a directory compliant with "Open Container Image Lay‐
93 out Specification" at path.
94
95
96 oci-archive:path:tag
97 An image tag in a tar archive compliant with "Open Container Image
98 Layout Specification" at path.
99
100
101 See containers-transports(5) ⟨https://github.com/contain‐
102 ers/image/blob/master/docs/containers-transports.5.md⟩ for details.
103
104
106 --command-timeout duration Timeout for the command execution.
107
108
109 --debug enable debug output
110
111
112 --help|-h Show help
113
114
115 --insecure-policy Adopt an insecure, permissive policy that allows any‐
116 thing. This obviates the need for a policy file.
117
118
119 --override-arch arch Use arch instead of the architecture of the
120 machine for choosing images.
121
122
123 --override-os OS Use OS instead of the running OS for choosing images.
124
125
126 --override-variant VARIANT Use VARIANT instead of the running architec‐
127 ture variant for choosing images.
128
129
130 --policy path-to-policy Path to a policy.json file to use for verifying
131 signatures and deciding whether an image is trusted, overriding the
132 default trust policy file.
133
134
135 --registries.d dir use registry configuration files in dir (e.g. for
136 container signature storage), overriding the default path.
137
138
139 --tmpdir dir used to store temporary files. Defaults to /var/tmp.
140
141
142 --version|-v print the version number
143
144
146 ┌────────────────────────────────┬────────────────────────────────┐
147 │Command │ Description │
148 ├────────────────────────────────┼────────────────────────────────┤
149 │skopeo-copy(1) │ │
150 ├────────────────────────────────┼────────────────────────────────┤
151 │⟨skopeo-copy.1.md⟩ │ Copy an image (manifest, │
152 │ │ filesystem layers, signatures) │
153 │ │ from one location to another. │
154 ├────────────────────────────────┼────────────────────────────────┤
155 │skopeo-delete(1) │ │
156 ├────────────────────────────────┼────────────────────────────────┤
157 │⟨skopeo-delete.1.md⟩ │ Mark image-name for deletion. │
158 ├────────────────────────────────┼────────────────────────────────┤
159 │skopeo-inspect(1) │ │
160 ├────────────────────────────────┼────────────────────────────────┤
161 │⟨skopeo-inspect.1.md⟩ │ Return low-level information │
162 │ │ about image-name in a reg‐ │
163 │ │ istry. │
164 ├────────────────────────────────┼────────────────────────────────┤
165 │skopeo-list-tags(1) │ │
166 ├────────────────────────────────┼────────────────────────────────┤
167 │⟨skopeo-list-tags.1.md⟩ │ List the tags for the given │
168 │ │ transport/repository. │
169 ├────────────────────────────────┼────────────────────────────────┤
170 │skopeo-login(1) │ │
171 ├────────────────────────────────┼────────────────────────────────┤
172 │⟨skopeo-login.1.md⟩ │ Login to a container registry. │
173 ├────────────────────────────────┼────────────────────────────────┤
174 │skopeo-logout(1) │ │
175 ├────────────────────────────────┼────────────────────────────────┤
176 │⟨skopeo-logout.1.md⟩ │ Logout of a container reg‐ │
177 │ │ istry. │
178 ├────────────────────────────────┼────────────────────────────────┤
179 │skopeo-manifest-digest(1) │ │
180 ├────────────────────────────────┼────────────────────────────────┤
181 │⟨skopeo-manifest-digest.1.md⟩ │ Compute a manifest digest of │
182 │ │ manifest-file and write it to │
183 │ │ standard output. │
184 ├────────────────────────────────┼────────────────────────────────┤
185 │skopeo-standalone-sign(1) │ │
186 ├────────────────────────────────┼────────────────────────────────┤
187 │⟨skopeo-standalone-sign.1.md⟩ │ Sign an image. │
188 ├────────────────────────────────┼────────────────────────────────┤
189 │skopeo-standalone-verify(1) │ │
190 ├────────────────────────────────┼────────────────────────────────┤
191 │⟨skopeo-standalone-verify.1.md⟩ │ Verify an image. │
192 ├────────────────────────────────┼────────────────────────────────┤
193 │skopeo-sync(1) │ │
194 ├────────────────────────────────┼────────────────────────────────┤
195 │⟨skopeo-sync.1.md⟩ │ Copy images from one or more │
196 │ │ repositories to a user speci‐ │
197 │ │ fied destination. │
198 ├────────────────────────────────┼────────────────────────────────┤
199 │ │ │
200 └────────────────────────────────┴────────────────────────────────┘
201
203 /etc/containers/policy.json
204 Default trust policy file, if --policy is not specified.
205 The policy format is documented in containers-policy.json(5)
206 ⟨https://github.com/containers/image/blob/master/docs/containers-pol‐
207 icy.json.5.md⟩ .
208
209
210 /etc/containers/registries.d
211 Default directory containing registry configuration, if --reg‐
212 istries.d is not specified.
213 The contents of this directory are documented in containers-pol‐
214 icy.json(5) ⟨https://github.com/containers/image/blob/master/docs/con‐
215 tainers-policy.json.5.md⟩.
216
217
219 skopeo-login(1), docker-login(1), containers-auth.json(5), contain‐
220 ers-storage.conf(5), containers-policy.json(5), containers-trans‐
221 ports(5)
222
223
225 Antonio Murdaca runcom@redhat.com ⟨mailto:runcom@redhat.com⟩, Miloslav
226 Trmac mitr@redhat.com ⟨mailto:mitr@redhat.com⟩, Jhon Honce jhonce@red‐
227 hat.com ⟨mailto:jhonce@redhat.com⟩
228
229
230
231Pages Man SKOPEO(1)(Skopeo)