commands.sh

crane

all

Container images managing tool. Some subcommands such as `pull`, `push`, `copy`, etc. have their own usage documentation.

More info →

Subcommands (22)

crane append

Push an image based on an (optional) base image. Appends layers containing the contents of the provided tarballs.

→
crane auth

Log in or access credentials.

→
crane blob

Read a blob from a registry.

→
crane catalog

List the repositories in a registry.

→
crane config

Get the configuration of an image.

→
crane copy

Efficiently copy a remote image from source to target while retaining the digest value.

→
crane cp

This command is an alias of `crane copy`.

→
crane delete

Delete an image reference from its registry.

→
crane digest

Get the digest of an image.

→
crane export

Export filesystem of a container image as a tarball.

→
crane flatten

Flatten an image's layers into a single layer. Pushes digest to original image repository if no tags are specified.

→
crane index

Modify an image index. Some subcommands such as `append` and `filter` have their own usage documentation.

→
crane ls

List the tags in a repository.

→
crane manifest

Get the manifest of an image.

→
crane mutate

Modify image labels and annotations. The container must be pushed to a registry, and the manifest is updated there.

→
crane pull

Pull remote images by reference and store their contents locally.

→
crane push

Push local image contents to a remote registry.

→
crane rebase

Rebase an image onto a new base image.

→
crane registry

This command serves a registry implementation on an automatically chosen port (`:0`), `$PORT`, or `--address`. The command blocks while the server accepts pushes and pulls and contents are can be stored in memory, and disk.

→
crane tag

Efficiently tag a remote image without downloading it, which differs from the `copy` command. It skips the layer existence checks because we know the manifest already exists making it slightly faster.

→
crane validate

Validate that an image is well-formed.

→
crane version

Print the version of a binary. The version string is completely dependent on how the binary was built, so you should not depend on the version format. It may change without notice.

→

Options (5)

-u, --usernameboolean

Log in to a registry

Example: crane auth login {{registry}} {{[-u|--username]}} {{user}} {{[-p|--password]}} {{password}}
-p, --passwordboolean

Log in to a registry

Example: crane auth login {{registry}} {{[-u|--username]}} {{user}} {{[-p|--password]}} {{password}}
-o, --omit-digest-tagsboolean

List the tags in a repository

Example: crane ls {{repository}} {{[-o|--omit-digest-tags]}}
boolean

Efficiently copy a remote image while retaining the digest value

Example: crane {{[cp|copy]}} {{source}} {{destination}} {{[-a|--all-tags]}}
-a, --all-tagsboolean

Efficiently copy a remote image while retaining the digest value

Example: crane {{[cp|copy]}} {{source}} {{destination}} {{[-a|--all-tags]}}

Examples (8)

Log in to a registry

crane auth login registry [-u|--username] user [-p|--password] password

List the repos in a registry

crane catalog registry --full-ref

List the tags in a repository

crane ls repository [-o|--omit-digest-tags]

Pull remote images by reference and store their contents locally

crane pull image tarball

Push local image contents to a remote registry

crane push path/to/directory_or_tarball image

Efficiently tag a remote image

Efficiently copy a remote image while retaining the digest value

crane [cp|copy] source destination [-a|--all-tags]

Delete an image reference from its registry

made by @shridhargupta | data from tldr-pages