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       --dir=""      download images to the specific directory
48
49
50       --disable-cache[=false]      do not use or create cached images/blobs
51
52
53       --docker-login[=false]      login to a Docker Repository interactively
54
55
56       -F, --force[=false]      overwrite an image file if it exists
57
58
59       -h, --help[=false]      help for pull
60
61
62       --library=""      download images from the provided library
63
64
65       --no-cleanup[=false]       do  NOT  clean up bundle after failed build,
66       can be helpful for debugging
67
68
69       --no-https[=false]      use http instead of https for docker:// oras://
70       and library:///... URIs
71
72
73

EXAMPLE

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

SEE ALSO

91       apptainer(1)
92
93
94

HISTORY

96       29-Mar-2023 Auto generated by spf13/cobra
97
98
99
100Auto generated by spf13/cobra      Mar 2023                       apptainer(1)