.nh
.TH "singularity" "1" "Apr 2024" "Auto generated by spf13/cobra" ""

.SH NAME
.PP
singularity-pull - Pull an image from a URI


.SH SYNOPSIS
.PP
\fBsingularity pull [pull options...] [output file] \fP


.SH DESCRIPTION
.PP
The 'pull' command allows you to download or build a container from a given
  URI. Supported URIs include:

.PP
library: Pull an image from the currently configured library
      library://user/collection/container[:tag]

.PP
docker: Pull a Docker/OCI image from Docker Hub, or another OCI registry.
      docker://user/image:tag

.PP
shub: Pull an image from Singularity Hub
      shub://user/image:tag

.PP
oras: Pull an image from an OCI registry that supports ORAS / OCI artifacts.
      oras://registry/namespace/image:tag

.PP
http, https: Pull an image using the http(s?) protocol
      https://example.com/containers/mycontainer.sif

.PP
By default, images from a library URI will be pulled in the same format they
  were uploaded. If the --oci flag is specified then the pull is required
  to result in an OCI-SIF image.

.PP
By default, images pulled from docker and other oci URIs will be converted
  into a singularity native SIF image. If the --oci flag is specified then they
  will be encapsulated in an OCI-SIF image.

.PP
Images pulled from a shub/oras/http/https URI are always directly downloaded,
  in the same format as they were uploaded.


.SH OPTIONS
.PP
\fB--arch\fP=""
	architecture to use when pulling images

.PP
\fB--authfile\fP=""
	Docker-style authentication file to use for writing/reading OCI registry credentials

.PP
\fB--dir\fP=""
	download images to the specific directory

.PP
\fB--disable-cache\fP[=false]
	dont use cached images/blobs and dont create them

.PP
\fB--docker-host\fP=""
	specify a custom Docker daemon host

.PP
\fB--docker-login\fP[=false]
	login to a Docker Repository interactively

.PP
\fB-F\fP, \fB--force\fP[=false]
	overwrite an image file if it exists

.PP
\fB-h\fP, \fB--help\fP[=false]
	help for pull

.PP
\fB--keep-layers\fP[=false]
	Keep layers when creating an OCI-SIF. Do not squash to a single layer.

.PP
\fB--library\fP=""
	download images from the provided library

.PP
\fB--no-cleanup\fP[=false]
	do NOT clean up bundle after failed build, can be helpful for debugging

.PP
\fB--no-https\fP[=false]
	use http instead of https for docker:// oras:// and library:///... URIs

.PP
\fB--no-oci\fP[=false]
	Launch container with native runtime

.PP
\fB--oci\fP[=false]
	Launch container with OCI runtime (experimental)

.PP
\fB--platform\fP=""
	platform (OS/Architecture/Variant) to use when pulling images


.SH EXAMPLE
.EX

  From Sylabs cloud library
  $ singularity pull alpine.sif library://alpine:latest

  From Docker to a singularity native SIF image
  $ singularity pull tensorflow.sif docker://tensorflow/tensorflow:latest

  From Docker to an OCI-SIF image
  $ singularity pull --oci tensorflow.oci.sif docker://tensorflow/tensorflow:latest

  From Shub
  $ singularity pull singularity-images.sif shub://vsoch/singularity-images

  From an OCI registry supporting ORAS / OCI artifacts
  $ singularity pull image.sif oras://<username>.azurecr.io/namespace/image:tag
.EE


.SH SEE ALSO
.PP
\fBsingularity(1)\fP


.SH HISTORY
.PP
7-Apr-2024 Auto generated by spf13/cobra