1SKOPEO(1)(Skopeo) SKOPEO(1)(Skopeo)
2Jhon Honce August 2016
6
8 skopeo -- Command line utility used to interact with local and remote
9 container images and container image registries
10
13 skopeo [global options] command [command options]
14
17 skopeo is a command line utility providing various operations with con‐
18 tainer images and container image registries.
19 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 skopeo can convert a Docker schema 2 or schema 1 container image to an
27 OCI image.
28 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 skopeo can sign and verify container images.
42 skopeo can delete container images from a remote container registry.
45 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
54 Most commands refer to container images, using a transport:details for‐
55 mat. The following formats are supported:
56 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 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 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 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 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-daemon:algo:di‐
88 gest (an image ID).
89 oci:path:tag
92 An image tag in a directory compliant with "Open Container Image Lay‐
93 out Specification" at path.
94 oci-archive:path:tag
97 An image tag in a tar archive compliant with "Open Container Image
98 Layout Specification" at path.
99 See containers-transports(5) ⟨https://github.com/containers/im‐
102 age/blob/master/docs/containers-transports.5.md⟩ for details.
103
106 --command-timeout duration
107 Timeout for the command execution.
110 --debug
113 enable debug output
116 --help, -h
119 Show help
122 --insecure-policy
125 Adopt an insecure, permissive policy that allows anything. This obvi‐
128 ates the need for a policy file.
129 --override-arch arch
132 Use arch instead of the architecture of the machine for choosing im‐
135 ages.
136 --override-os os
139 Use OS instead of the running OS for choosing images.
142 --override-variant variant
145 Use variant instead of the running architecture variant for choosing
148 images.
149 --policy path-to-policy
152 Path to a policy.json file to use for verifying signatures and deciding
155 whether an image is trusted, overriding the default trust policy file.
156 --registries.d dir
159 Use registry configuration files in dir (e.g. for container signature
162 storage), overriding the default path.
163 --tmpdir dir
166 Directory used to store temporary files. Defaults to /var/tmp.
169 --version, -v
172 Print the version number
175
178 ┌────────────────────────────────┬─────────────────────────────────────────────────────────────────────────────┐
179 │Command │ Description │
180 ├────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────┤
181 │skopeo-copy(1) │ │
182 ├────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────┤
183 │⟨skopeo-copy.1.md⟩ │ Copy an image (manifest, filesystem layers, signatures) from one location │
184 │ │ to another. │
185 ├────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────┤
186 │skopeo-delete(1) │ │
187 ├────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────┤
188 │⟨skopeo-delete.1.md⟩ │ Mark the image-name for later deletion by the registry's garbage collector. │
189 ├────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────┤
190 │skopeo-inspect(1) │ │
191 ├────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────┤
192 │⟨skopeo-inspect.1.md⟩ │ Return low-level information about image-name in a registry. │
193 ├────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────┤
194 │skopeo-list-tags(1) │ │
195 ├────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────┤
196 │⟨skopeo-list-tags.1.md⟩ │ List tags in the transport-specific image repository. │
197 ├────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────┤
198 │skopeo-login(1) │ │
199 ├────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────┤
200 │⟨skopeo-login.1.md⟩ │ Login to a container registry. │
201 ├────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────┤
202 │skopeo-logout(1) │ │
203 ├────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────┤
204 │⟨skopeo-logout.1.md⟩ │ Logout of a container registry. │
205 ├────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────┤
206 │skopeo-manifest-digest(1) │ │
207 ├────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────┤
208 │⟨skopeo-manifest-digest.1.md⟩ │ Compute a manifest digest for a manifest-file and write it to standard out‐ │
209 │ │ put. │
210 ├────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────┤
211 │skopeo-standalone-sign(1) │ │
212 ├────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────┤
213 │⟨skopeo-standalone-sign.1.md⟩ │ Debugging tool - Publish and sign an image in one step. │
214 ├────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────┤
215 │skopeo-standalone-verify(1) │ │
216 ├────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────┤
217 │⟨skopeo-standalone-verify.1.md⟩ │ Verify an image signature. │
218 ├────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────┤
219 │skopeo-sync(1) │ │
220 ├────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────┤
221 │⟨skopeo-sync.1.md⟩ │ Synchronize images between container registries and local directories. │
222 └────────────────────────────────┴─────────────────────────────────────────────────────────────────────────────┘
223
225 /etc/containers/policy.json
226 Default trust policy file, if --policy is not specified.
227 The policy format is documented in containers-policy.json(5)
228 ⟨https://github.com/containers/image/blob/master/docs/containers-pol‐
229 icy.json.5.md⟩ .
230 /etc/containers/registries.d
233 Default directory containing registry configuration, if --reg‐
234 istries.d is not specified.
235 The contents of this directory are documented in containers-pol‐
236 icy.json(5) ⟨https://github.com/containers/image/blob/master/docs/con‐
237 tainers-policy.json.5.md⟩.
238
241 skopeo-login(1), docker-login(1), containers-auth.json(5), containers-
242 storage.conf(5), containers-policy.json(5), containers-transports(5)
243
246 Antonio Murdaca runcom@redhat.com ⟨mailto:runcom@redhat.com⟩, Miloslav
247 Trmac mitr@redhat.com ⟨mailto:mitr@redhat.com⟩, Jhon Honce jhonce@red‐
248 hat.com ⟨mailto:jhonce@redhat.com⟩
249Pages Man SKOPEO(1)(Skopeo)