1singularity(1) singularity(1)
2
6 singularity-run - Run the user-defined default command within a
7 container
8
12 singularity run [run options...] <container>
13
17 This command will launch a Singularity container and execute a
18 runscript
19 if one is defined for that container. The runscript is a metadata
20 file within
21 the container that contains shell commands. If the file is present
22 (and
23 executable) then this command will execute that file within the
24 container
25 automatically. All arguments following the container name will be
26 passed
27 directly to the runscript.
28 singularity run accepts the following container formats:
31 *.sif Singularity Image Format (SIF). Native to
34 Singularity 3.0+
35 *.sqsh SquashFS format. Native to Singularity 2.4+
38 *.img ext3 format. Native to Singularity versions < 2.4.
41 directory/ sandbox format. Directory containing a valid root
44 file
45 system and optionally Singularity meta-data.
46 instance://* A local running instance of a container. (See the
49 instance
50 command group.)
51 library://* A container hosted on a Library (default
54 ⟨https://cloud.sylabs.io/library)⟩
56 docker://* A container hosted on Docker Hub
59 shub://* A container hosted on Singularity Hub
62 oras://* A container hosted on a supporting OCI registry
65
69 --add-caps=""
70 a comma separated capability list to add
71 --allow-setuid[=false]
74 allow setuid binaries in container (root only)
75 --app=""
78 set an application to run inside a container
79 --apply-cgroups=""
82 apply cgroups from file for container processes (root only)
83 -B, --bind=[]
86 a user-bind path specification. spec has the format
87 src[:dest[:opts]], where src and dest are outside and inside paths. If
88 dest is not given, it is set equal to src. Mount options ('opts') may
89 be specified as 'ro' (read-only) or 'rw' (read/write, which is the
90 default). Multiple bind paths can be given by a comma separated list.
91 -e, --cleanenv[=false]
94 clean environment before running container
95 -c, --contain[=false]
98 use minimal /dev and empty other directories (e.g. /tmp and $HOME)
99 instead of sharing filesystems from your host
100 -C, --containall[=false]
103 contain not only file systems, but also PID, IPC, and environment
104 --disable-cache[=false]
107 dont use cache, and dont create cache
108 --dns=""
111 list of DNS server separated by commas to add in resolv.conf
112 --docker-login[=false]
115 login to a Docker Repository interactively
116 --drop-caps=""
119 a comma separated capability list to drop
120 -f, --fakeroot[=false]
123 run container in new user namespace as uid 0
124 -h, --help[=false]
127 help for run
128 -H, --home="/builddir"
131 a home directory specification. spec can either be a src path or
132 src:dest pair. src is the source path of the home directory outside
133 the container and dest overrides the home directory within the
134 container.
135 --hostname=""
138 set container hostname
139 -i, --ipc[=false]
142 run container in a new IPC namespace
143 --keep-privs[=false]
146 let root user keep privileges in container (root only)
147 -n, --net[=false]
150 run container in a new network namespace (sets up a bridge network
151 interface by default)
152 --network="bridge"
155 specify desired network type separated by commas, each network will
156 bring up a dedicated interface inside container
157 --network-args=[]
160 specify network arguments to pass to CNI plugins
161 --no-home[=false]
164 do NOT mount users home directory if home is not the current
165 working directory
166 --no-init[=false]
169 do NOT start shim process with --pid
170 --no-nv[=false]
173 --no-privs[=false]
176 drop all privileges from root user in container)
177 --nohttps[=false]
180 do NOT use HTTPS with the docker:// transport (useful for local
181 docker registries without a certificate)
182 --nonet[=false]
185 disable VM network handling
186 --nv[=false]
189 enable experimental Nvidia support
190 -o, --overlay=[]
193 use an overlayFS image for persistent data storage or as read-only
194 layer of container
195 --passphrase[=false]
198 prompt for an encryption passphrase
199 --pem-path=""
202 enter an path to a PEM formated RSA key for an encrypted container
203 -p, --pid[=false]
206 run container in a new PID namespace
207 --pwd=""
210 initial working directory for payload process inside the container
211 --rocm[=false]
214 enable experimental Rocm support
215 -S, --scratch=[]
218 include a scratch directory within the container that is linked to
219 a temporary dir (use -W to force location)
220 --security=[]
223 enable security features (SELinux, Apparmor, Seccomp)
224 -u, --userns[=false]
227 run container in a new user namespace, allowing Singularity to run
228 completely unprivileged on recent kernels. This disables some features
229 of Singularity, for example it only works with sandbox images.
230 --uts[=false]
233 run container in a new UTS namespace
234 --vm[=false]
237 enable VM support
238 --vm-cpu="1"
241 number of CPU cores to allocate to Virtual Machine (implies --vm)
242 --vm-err[=false]
245 enable attaching stderr from VM
246 --vm-ip="dhcp"
249 IP Address to assign for container usage. Defaults to DHCP within
250 bridge network.
251 --vm-ram="1024"
254 amount of RAM in MiB to allocate to Virtual Machine (implies --vm)
255 -W, --workdir=""
258 working directory to be used for /tmp, /var/tmp and $HOME (if
259 -c/--contain was also used)
260 -w, --writable[=false]
263 by default all Singularity containers are available as read only.
264 This option makes the file system accessible as read/write.
265 --writable-tmpfs[=false]
268 makes the file system accessible as read-write with non persistent
269 data (with overlay support only)
270
274 # Here we see that the runscript prints "Hello world: "
275 $ singularity exec /tmp/debian.sif cat /singularity
276 #!/bin/sh
277 echo "Hello world: "
278 # It runs with our inputs when we run the image
280 $ singularity run /tmp/debian.sif one two three
281 Hello world: one two three
282 # Note that this does the same thing
284 $ ./tmp/debian.sif one two three
285
290 singularity(1)
291
295 18-Feb-2020 Auto generated by spf13/cobra
296Auto generated by spf13/cobra Feb 2020 singularity(1)