1apptainer(1)                                                      apptainer(1)
2
3
4

NAME

6       apptainer-pull - Pull an image from a URI
7
8
9

SYNOPSIS

11       apptainer pull [pull options...] [output file]
12
13
14

DESCRIPTION

16       The  'pull'  command allows you to download or build a container from a
17       given
18         URI. Supported URIs include:
19
20
21       library: Pull an image from the currently configured library
22             library://user/collection/container[:tag]
23
24
25       docker: Pull a Docker/OCI image from Docker Hub, or  another  OCI  reg‐
26       istry.
27             docker://user/image:tag
28
29
30       shub: Pull an image from Singularity Hub
31             shub://user/image:tag
32
33
34       oras: Pull a SIF image from an OCI registry that supports ORAS.
35             oras://registry/namespace/image:tag
36
37
38       http, https: Pull an image using the http(s?) protocol
39             https://library.sylabs.io/v1/imagefile/library/de‐
40       fault/alpine:latest
41
42
43

OPTIONS

45       --arch="amd64"      architecture to pull from library
46
47
48       --dir=""      download images to the specific directory
49
50
51       --disable-cache[=false]      dont use cached images/blobs and dont cre‐
52       ate them
53
54
55       --docker-login[=false]      login to a Docker Repository interactively
56
57
58       -F, --force[=false]      overwrite an image file if it exists
59
60
61       -h, --help[=false]      help for pull
62
63
64       --library=""      download images from the provided library
65
66
67       --no-cleanup[=false]       do  NOT  clean up bundle after failed build,
68       can be helpful for debugging
69
70
71       --no-https[=false]      use http instead of https for docker:// oras://
72       and library:///... URIs
73
74
75

EXAMPLE

77                From a library
78                $ apptainer pull alpine.sif library://alpine:latest
79
80                From Docker
81                $ apptainer pull tensorflow.sif docker://tensorflow/tensorflow:latest
82
83                From Shub
84                $ apptainer pull apptainer-images.sif shub://vsoch/apptainer-images
85
86                From supporting OCI registry (e.g. Azure Container Registry)
87                $ apptainer pull image.sif oras://<username>.azurecr.io/namespace/image:tag
88
89
90
91

SEE ALSO

93       apptainer(1)
94
95
96

HISTORY

98       22-Jun-2022 Auto generated by spf13/cobra
99
100
101
102Auto generated by spf13/cobra      Jun 2022                       apptainer(1)