1singularity(1) singularity(1)
2
6 singularity-shell - Run a shell within a container
7
11 singularity shell [shell options...]
12
16 singularity shell supports the following formats:
17 *.sif Singularity Image Format (SIF). Native to Singular‐
20 ity 3.0+
21 *.sqsh SquashFS format. Native to Singularity 2.4+
24 *.img ext3 format. Native to Singularity versions < 2.4.
27 directory/ sandbox format. Directory containing a valid root
30 file
31 system and optionally Singularity meta-data.
32 instance://* A local running instance of a container. (See the
35 instance
36 command group.)
37 library://* A SIF container hosted on a Library
40 (default https://cloud.sylabs.io/library)
41 docker://* A Docker/OCI container hosted on Docker Hub or
44 another
45 OCI registry.
46 shub://* A container hosted on Singularity Hub.
49 oras://* A SIF container hosted on an OCI registry that sup‐
52 ports
53 the OCI Registry As Storage (ORAS) specification.
54
58 --add-caps="" a comma separated capability list to add
59 --allow-setuid[=false] allow setuid binaries in container (root
62 only)
63 --app="" set an application to run inside a container
66 --apply-cgroups="" apply cgroups from file for container processes
69 (root only)
70 -B, --bind=[] a user-bind path specification. spec has the format
73 src[:dest[:opts]], where src and dest are outside and inside paths. If
74 dest is not given, it is set equal to src. Mount options ('opts') may
75 be specified as 'ro' (read-only) or 'rw' (read/write, which is the
76 default). Multiple bind paths can be given by a comma separated list.
77 -e, --cleanenv[=false] clean environment before running container
80 -c, --contain[=false] use minimal /dev and empty other directories
83 (e.g. /tmp and $HOME) instead of sharing filesystems from your host
84 -C, --containall[=false] contain not only file systems, but also
87 PID, IPC, and environment
88 --disable-cache[=false] dont use cache, and dont create cache
91 --dns="" list of DNS server separated by commas to add in
94 resolv.conf
95 --docker-login[=false] login to a Docker Repository interactively
98 --drop-caps="" a comma separated capability list to drop
101 --env=[] pass environment variable to contained process
104 --env-file="" pass environment variables from file to contained
107 process
108 -f, --fakeroot[=false] run container in new user namespace as uid
111 0
112 --fusemount=[] A FUSE filesystem mount specification of the form
115 ': ' - where is 'container' or 'host', specifying where the mount will
116 be performed ('container-daemon' or 'host-daemon' will run the FUSE
117 process detached). is the path to the FUSE executable, plus options
118 for the mount. is the location in the container to which the FUSE
119 mount will be attached. E.g. 'container:sshfs 10.0.0.1:/ /sshfs'.
120 Implies --pid.
121 -h, --help[=false] help for shell
124 -H, --home="/builddir" a home directory specification. spec can
127 either be a src path or src:dest pair. src is the source path of the
128 home directory outside the container and dest overrides the home direc‐
129 tory within the container.
130 --hostname="" set container hostname
133 -i, --ipc[=false] run container in a new IPC namespace
136 --keep-privs[=false] let root user keep privileges in container
139 (root only)
140 -n, --net[=false] run container in a new network namespace (sets
143 up a bridge network interface by default)
144 --network="bridge" specify desired network type separated by com‐
147 mas, each network will bring up a dedicated interface inside container
148 --network-args=[] specify network arguments to pass to CNI plugins
151 --no-home[=false] do NOT mount users home directory if /home is
154 not the current working directory
155 --no-init[=false] do NOT start shim process with --pid
158 --no-mount=[] disable one or more mount xxx options set in singu‐
161 larity.conf
162 --no-privs[=false] drop all privileges from root user in con‐
165 tainer)
166 --no-umask[=false] do not propagate umask to the container, set
169 default 0022 umask
170 --nohttps[=false] do NOT use HTTPS with the docker:// transport
173 (useful for local docker registries without a certificate)
174 --nonet[=false] disable VM network handling
177 --nv[=false] enable experimental Nvidia support
180 -o, --overlay=[] use an overlayFS image for persistent data stor‐
183 age or as read-only layer of container
184 --passphrase[=false] prompt for an encryption passphrase
187 --pem-path="" enter an path to a PEM formated RSA key for an
190 encrypted container
191 -p, --pid[=false] run container in a new PID namespace
194 --pwd="" initial working directory for payload process inside the
197 container
198 --rocm[=false] enable experimental Rocm support
201 -S, --scratch=[] include a scratch directory within the container
204 that is linked to a temporary dir (use -W to force location)
205 --security=[] enable security features (SELinux, Apparmor, Sec‐
208 comp)
209 -s, --shell="" path to program to use for interactive shell
212 --syos[=false] execute SyOS shell
215 -u, --userns[=false] run container in a new user namespace, allow‐
218 ing Singularity to run completely unprivileged on recent kernels. This
219 disables some features of Singularity, for example it only works with
220 sandbox images.
221 --uts[=false] run container in a new UTS namespace
224 --vm[=false] enable VM support
227 --vm-cpu="1" number of CPU cores to allocate to Virtual Machine
230 (implies --vm)
231 --vm-err[=false] enable attaching stderr from VM
234 --vm-ip="dhcp" IP Address to assign for container usage. Defaults
237 to DHCP within bridge network.
238 --vm-ram="1024" amount of RAM in MiB to allocate to Virtual
241 Machine (implies --vm)
242 -W, --workdir="" working directory to be used for /tmp, /var/tmp
245 and $HOME (if -c/--contain was also used)
246 -w, --writable[=false] by default all Singularity containers are
249 available as read only. This option makes the file system accessible as
250 read/write.
251 --writable-tmpfs[=false] makes the file system accessible as
254 read-write with non persistent data (with overlay support only)
255
259 $ singularity shell /tmp/Debian.sif
260 Singularity/Debian.sif> pwd
261 /home/gmk/test
262 Singularity/Debian.sif> exit
263 $ singularity shell -C /tmp/Debian.sif
265 Singularity/Debian.sif> pwd
266 /home/gmk
267 Singularity/Debian.sif> ls -l
268 total 0
269 Singularity/Debian.sif> exit
270 $ sudo singularity shell -w /tmp/Debian.sif
272 $ sudo singularity shell --writable /tmp/Debian.sif
273 $ singularity shell instance://my_instance
275 $ singularity shell instance://my_instance
277 Singularity: Invoking an interactive shell within container...
278 Singularity container: > ps -ef
279 UID PID PPID C STIME TTY TIME CMD
280 ubuntu 1 0 0 20:00 ? 00:00:00 /usr/local/bin/singularity/bin/sinit
281 ubuntu 2 0 0 20:01 pts/8 00:00:00 /bin/bash --norc
282 ubuntu 3 2 0 20:02 pts/8 00:00:00 ps -ef
283
288 singularity(1)
289
293 11-Mar-2021 Auto generated by spf13/cobra
294Auto generated by spf13/cobra Mar 2021 singularity(1)