1singularity(1)                                                  singularity(1)
2
3
4

NAME

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

SYNOPSIS

11       singularity pull [pull options...] [output file] <URI>
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 an image from Docker Hub
26             docker://user/image:tag
27
28
29       shub: Pull an image from Singularity Hub
30             shub://user/image:tag
31
32
33       oras: Pull a SIF image from a supporting OCI registry
34             oras://registry/namespace/image:tag
35
36
37       http, https: Pull an image using the http(s?) protocol
38
39       ⟨https://library.sylabs.io/v1/imagefile/library/default/alpine:latest⟩
40
41
42

OPTIONS

44       --arch="amd64"
45           architecture to pull from library
46
47
48       --dir=""
49           download images to the specific directory
50
51
52       --disable-cache[=false]
53           dont use cached images/blobs and dont create them
54
55
56       --docker-login[=false]
57           login to a Docker Repository interactively
58
59
60       -F, --force[=false]
61           overwrite an image file if it exists
62
63
64       -h, --help[=false]
65           help for pull
66
67
68       --library=" ⟨https://library.sylabs.io"⟩
69           download images from the provided library
70
71
72       --no-cleanup[=false]
73           do NOT clean up bundle after failed build, can be helpul for
74       debugging
75
76
77       --nohttps[=false]
78           do NOT use HTTPS with the docker:// transport (useful for local
79       docker registries without a certificate)
80
81
82

EXAMPLE

84                From Sylabs cloud library
85                $ singularity pull alpine.sif library://alpine:latest
86
87                From Docker
88                $ singularity pull tensorflow.sif docker://tensorflow/tensorflow:latest
89
90                From Shub
91                $ singularity pull singularity-images.sif shub://vsoch/singularity-images
92
93                From supporting OCI registry (e.g. Azure Container Registry)
94                $ singularity pull image.sif oras://<username>.azurecr.io/namespace/image:tag
95
96
97
98

SEE ALSO

100       singularity(1)
101
102
103

HISTORY

105       18-Feb-2020 Auto generated by spf13/cobra
106
107
108
109Auto generated by spf13/cobra      Feb 2020                     singularity(1)