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://example.com/alpine.sif
40
41
42

OPTIONS

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

EXAMPLE

81                From a library
82                $ apptainer pull alpine.sif library://alpine:latest
83
84                From Docker
85                $ apptainer pull tensorflow.sif docker://tensorflow/tensorflow:latest
86                $ apptainer pull --arch arm --arch-variant 6 alpine.sif docker://alpine:latest
87
88                From Shub
89                $ apptainer pull apptainer-images.sif shub://vsoch/apptainer-images
90
91                From supporting OCI registry (e.g. Azure Container Registry)
92                $ apptainer pull image.sif oras://<username>.azurecr.io/namespace/image:tag
93
94
95
96

SEE ALSO

98       apptainer(1)
99
100
101

HISTORY

103       22-Nov-2023 Auto generated by spf13/cobra
104
105
106
107Auto generated by spf13/cobra      Nov 2023                       apptainer(1)