.nh
.TH "apptainer" "1" "Sep 2024" "Auto generated by spf13/cobra" ""

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


.SH SYNOPSIS
.PP
\fBapptainer 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 a SIF image from an OCI registry that supports ORAS.
      oras://registry/namespace/image:tag

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


.SH OPTIONS
.PP
\fB--arch\fP="amd64"
	architecture to pull from library

.PP
\fB--arch-variant\fP=""
	architecture variant to pull from library

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

.PP
\fB--disable-cache\fP[=false]
	do not use or create cached images/blobs

.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--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


.SH EXAMPLE
.EX

  From a library
  $ apptainer pull alpine.sif library://alpine:latest

  From Docker
  $ apptainer pull tensorflow.sif docker://tensorflow/tensorflow:latest
  $ apptainer pull --arch arm --arch-variant 6 alpine.sif docker://alpine:latest

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

  From supporting OCI registry (e.g. Azure Container Registry)
  $ apptainer pull image.sif oras://<username>.azurecr.io/namespace/image:tag

.EE


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


.SH HISTORY
.PP
23-Sep-2024 Auto generated by spf13/cobra