Skip to main content
Version: 1.2

oras pull

Pull files from a registry or an OCI image layout

oras pull [flags] <name>{:<tag>|@<digest>}

Examples

Pull artifact files from a registry:

oras pull localhost:5000/hello:v1

Recursively pulling all files from a registry, including subjects of hello:v1:

oras pull --include-subject localhost:5000/hello:v1

Pull files from an insecure registry:

oras pull --insecure localhost:5000/hello:v1

Pull files from the HTTP registry:

oras pull --plain-http localhost:5000/hello:v1

Pull files from a registry with local cache:

export ORAS_CACHE=~/.oras/cache
oras pull localhost:5000/hello:v1

Pull files from a registry with certain platform:

oras pull --platform linux/arm/v5 localhost:5000/hello:v1

Pull all files with concurrency level tuned:

oras pull --concurrency 6 localhost:5000/hello:v1

Pull artifact files from an OCI image layout folder 'layout-dir':

oras pull --oci-layout layout-dir:v1

Pull artifact files from an OCI layout archive 'layout.tar':

oras pull --oci-layout layout.tar:v1

Options

  -T, --allow-path-traversal                        allow storing files out of the output directory
--ca-file string server certificate authority file for the remote registry
--cert-file string client certificate file for the remote registry
--concurrency int concurrency level (default 3)
--config string output manifest config file
-d, --debug output debug logs (implies --no-tty)
--format string [Experimental] Format output using a custom template:
'json': Print in JSON format
'go-template': Print output using the given Go template
-H, --header stringArray add custom headers to requests
-h, --help help for pull
--identity-token string registry identity token
--identity-token-stdin read identity token from stdin
--include-subject [Preview] recursively pull the subject of artifacts
--insecure allow connections to SSL registry without certs
-k, --keep-old-files do not replace existing files when pulling, treat them as errors
--key-file string client private key file for the remote registry
--no-tty [Preview] do not show progress output
--oci-layout set target as an OCI image layout
-o, --output string output directory (default ".")
-p, --password string registry password or identity token
--password-stdin read password from stdin
--plain-http allow insecure connections to registry without SSL check
--platform os[/arch][/variant][:os_version] request platform in the form of os[/arch][/variant][:os_version]
--registry-config path path of the authentication file for registry
--resolve host:port:address[:address_port] customized DNS for registry, formatted in host:port:address[:address_port]
--template string [Experimental] Template string used to format output
-u, --username string registry username
-v, --verbose verbose output