1singularity(1) singularity(1)
2
6 singularity-shell - Run a shell within a container
7
11 singularity shell [shell options...] <container>
12
16 singularity shell supports the following formats:
17 *.sif Singularity Image Format (SIF). Native to
20 Singularity 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 container hosted on a Library (default
40 ⟨https://cloud.sylabs.io/library)⟩
42 docker://* A container hosted on Docker Hub
45 shub://* A container hosted on Singularity Hub
48
52 --add-caps=""
53 a comma separated capability list to add
54 --allow-setuid[=false]
57 allow setuid binaries in container (root only)
58 --app=""
61 set an application to run inside a container
62 --apply-cgroups=""
65 apply cgroups from file for container processes (root only)
66 -B, --bind=[]
69 a user-bind path specification. spec has the format
70 src[:dest[:opts]], where src and dest are outside and inside paths. If
71 dest is not given, it is set equal to src. Mount options ('opts') may
72 be specified as 'ro' (read-only) or 'rw' (read/write, which is the
73 default). Multiple bind paths can be given by a comma separated list.
74 -e, --cleanenv[=false]
77 clean environment before running container
78 -c, --contain[=false]
81 use minimal /dev and empty other directories (e.g. /tmp and $HOME)
82 instead of sharing filesystems from your host
83 -C, --containall[=false]
86 contain not only file systems, but also PID, IPC, and environment
87 --dns=""
90 list of DNS server separated by commas to add in resolv.conf
91 --docker-login[=false]
94 login to a Docker Repository interactively
95 --drop-caps=""
98 a comma separated capability list to drop
99 -h, --help[=false]
102 help for shell
103 -H, --home="/builddir"
106 a home directory specification. spec can either be a src path or
107 src:dest pair. src is the source path of the home directory outside
108 the container and dest overrides the home directory within the
109 container.
110 --hostname=""
113 set container hostname
114 -i, --ipc[=false]
117 run container in a new IPC namespace
118 --keep-privs[=false]
121 let root user keep privileges in container (root only)
122 -n, --net[=false]
125 run container in a new network namespace (sets up a bridge network
126 interface by default)
127 --network="bridge"
130 specify desired network type separated by commas, each network will
131 bring up a dedicated interface inside container
132 --network-args=[]
135 specify network arguments to pass to CNI plugins
136 --no-home[=false]
139 do NOT mount users home directory if home is not the current
140 working directory
141 --no-init[=false]
144 do NOT start shim process with --pid
145 --no-privs[=false]
148 drop all privileges from root user in container
149 --nohttps[=false]
152 do NOT use HTTPS, for communicating with local docker registry
153 --nv[=false]
156 enable experimental Nvidia support
157 -o, --overlay=[]
160 use an overlayFS image for persistent data storage or as read-only
161 layer of container
162 -p, --pid[=false]
165 run container in a new PID namespace
166 --pwd=""
169 initial working directory for payload process inside the container
170 -S, --scratch=[]
173 include a scratch directory within the container that is linked to
174 a temporary dir (use -W to force location)
175 --security=[]
178 enable security features (SELinux, Apparmor, Seccomp)
179 -s, --shell=""
182 path to program to use for interactive shell
183 -u, --userns[=false]
186 run container in a new user namespace, allowing Singularity to run
187 completely unprivileged on recent kernels. This disables some features
188 of Singularity, for example it only works with sandbox images.
189 --uts[=false]
192 run container in a new UTS namespace
193 --vm[=false]
196 enable VM support
197 --vm-cpu="1"
200 Number of CPU cores to allocate to Virtual Machine (implies --vm)
201 --vm-err[=false]
204 enable attaching stderr from VM
205 --vm-ram="1024"
208 Amount of RAM in MiB to allocate to Virtual Machine (implies --vm)
209 -W, --workdir=""
212 working directory to be used for /tmp, /var/tmp and $HOME (if
213 -c/--contain was also used)
214 -w, --writable[=false]
217 by default all Singularity containers are available as read only.
218 This option makes the file system accessible as read/write.
219 --writable-tmpfs[=false]
222 makes the file system accessible as read-write with non persistent
223 data (with overlay support only)
224
228 $ singularity shell /tmp/Debian.sif
229 Singularity/Debian.sif> pwd
230 /home/gmk/test
231 Singularity/Debian.sif> exit
232 $ singularity shell -C /tmp/Debian.sif
234 Singularity/Debian.sif> pwd
235 /home/gmk
236 Singularity/Debian.sif> ls -l
237 total 0
238 Singularity/Debian.sif> exit
239 $ sudo singularity shell -w /tmp/Debian.sif
241 $ sudo singularity shell --writable /tmp/Debian.sif
242 $ singularity shell instance://my_instance
244 $ singularity shell instance://my_instance
246 Singularity: Invoking an interactive shell within container...
247 Singularity container: > ps -ef
248 UID PID PPID C STIME TTY TIME CMD
249 ubuntu 1 0 0 20:00 ? 00:00:00 /usr/local/bin/singularity/bin/sinit
250 ubuntu 2 0 0 20:01 pts/8 00:00:00 /bin/bash --norc
251 ubuntu 3 2 0 20:02 pts/8 00:00:00 ps -ef
252
257 singularity(1)
258
262 29-May-2019 Auto generated by spf13/cobra
263Auto generated by spf13/cobra May 2019 singularity(1)