SKOPEO(1)(Skopeo)

📦
version 1.24.1 · 11 versions
, in arch rolling, nixpkgs unstable

💅 Skopeo(1) — Skopeo, the manual, bestie 💅

Jhon Honce · August 2016

okay so this is the Skopeo manual page, aka SKOPEO(1) — and yes, she is that icon. 🫶

🌸 NAME 🌸

skopeo -- command line utility used to interact with local and remote container images and container image registries. literally her whole thing. 💅

✨ SYNOPSIS ✨

skopeo [global options] command [command options]

💖 DESCRIPTION 💖

skopeo is a command line utility that gives you various operations with container images and container image registries. no cap, she does a lot. ✨

skopeo can copy container images between various container image stores, converting them as necessary. for example, you can use skopeo to copy container images from one container registry to another. iconic behavior. 🦋

skopeo can convert a Docker schema 2 or schema 1 container image to an OCI image.

skopeo can inspect a repository on a container registry without needlessly pulling the image. pulling an image from a repository — especially a remote repository — is an expensive network and storage operation. Skopeo fetches the repository’s manifest and displays a docker inspect-like json output about the repository or a tag. skopeo, in contrast to docker inspect, helps you gather useful information about a repository or a tag without requiring you to run docker pull — e.g. — Which tags are available for the given repository? Which labels does the image have? obsessed. 😭💖

skopeo can sign and verify container images.

skopeo can delete container images from a remote container registry.

Note: skopeo does not require any container runtimes to be running to do most of its functionality. It also does not require root, unless you are copying images into a container runtime storage backend, like the docker daemon or github.com/containers/storage. 🫶

🎀 IMAGE NAMES 🎀

Most commands refer to container images using a transport:details format. the following formats are supported, bestie:

  • containers-storage:docker-reference — an image located in a local containers/storage image store. Both the location and image store are specified in /etc/containers/storage.conf. (Backend for Podman, CRI-O, Buildah and friends.) 💅
  • dir:path — an existing local directory path storing the manifest, layer tarballs and signatures as individual files. This is a non-standardized format, primarily useful for debugging or noninvasive container inspection.
  • docker://docker-reference — an image in a registry implementing the "Docker Registry HTTP API V2". Credentials are typically managed using (skopeo login); see containers-auth.json(5) for more details about the credential search mechanism. 🔑
  • docker-archive:path[:docker-reference] — an image is stored in the docker save formatted file. docker-reference is only used when creating such a file, and it must not contain a digest.
  • docker-daemon:docker-reference — an image docker-reference stored in the docker daemon internal storage. docker-reference must contain either a tag or a digest. Alternatively, when reading images, the format can be docker-daemon:algo:digest (an image ID). 👑
  • oci:path:tag — an image tag in a directory compliant with "Open Container Image Layout Specification" at path.
  • oci-archive:path:tag — an image tag in a tar archive compliant with "Open Container Image Layout Specification" at path.

See containers-transports(5) ⟨https://github.com/containers/image/blob/main/docs/containers-transports.5.md⟩ for details. 🌈

💅 OPTIONS 💅

These options should be placed before the subcommand name. Individual subcommands have their own options. periodt. ✨

  • --command-timeout duration — timeout for the command execution (e.g. 30s, 10m). ⏳
  • --debug — enable debug output.
  • --help, -h — show help.
  • --insecure-policy — adopt an insecure, permissive policy that allows anything. This obviates the need for a policy file. ⚠️
  • --override-arch arch — use arch instead of the architecture of the machine for choosing images.
  • --override-os os — use OS instead of the running OS for choosing images.
  • --override-variant variant — use variant instead of the running architecture variant for choosing images.
  • --policy path-to-policy — path to a policy.json file to use for verifying signatures and deciding whether an image is trusted, overriding the default trust policy file.
  • --registries.d dir — use registry configuration files in dir (e.g. for container signature storage), overriding the default path.
  • --require-signed — require that any pulled image must be signed regardless of what the default or provided trust policy file says.
  • --tls-details path — path to a containers-tls-details(5) file, affecting TLS behavior throughout the program.

If not set, defaults to a reasonable default that may change over time (depending on system’s global policy, version of the program, version of the Go language, and the like).

Users should generally not use this option unless they have a process to ensure that the configuration will be kept up to date.

  • --tmpdir dir — directory used to store temporary files. Defaults to /var/tmp.
  • --user-agent-prefix prefix — prefix to add to the user agent string. The resulting user agent will be in the format "prefix skopeo/version".
  • --version, -v — print the version number.

👑 COMMANDS 👑

💖 EXIT STATUS 💖

okay so here’s the vibe check on how skopeo bows out: it exits with status 0 on success, non-zero on error. periodt. ✨

Details about the exit statuses:

  1. 1 — Generic error, details can be found in the error message. 💀
  2. 2 — The input image cannot be found. Note that this is best effort and for remote registries the status often cannot be reliably reported. 😭

📁 FILES 📁

👀 SEE ALSO 👀

like, go read these too, bestie — iykyk 🫶

💅 AUTHORS 💅

the icons who made this happen:

  • Antonio Murdaca runcom@redhat.com ⟨mailto:runcom@redhat.com⟩
  • Miloslav Trmac mitr@redhat.com ⟨mailto:mitr@redhat.com⟩
  • Jhon Honce jhonce@redhat.com ⟨mailto:jhonce@redhat.com⟩

okay that’s the whole page, bestie 💖 source/version footer energy is Pages / Man, the page tag is SKOPEO(1)(Skopeo), and the date vibe is August 2016. byeee ✨🎀🦋

📦 where this page comes from