1singularity(1) singularity(1)
2
3
4
6 singularity-inspect - Show metadata for an image
7
8
9
11 singularity inspect [inspect options...] <image path>
12
13
14
16 Inspect will show you labels, environment variables, apps and scripts
17 associated
18 with the image determined by the flags you pass. By default, they
19 will be shown in
20 plain text. If you would like to list them in json format, you should
21 use the --json flag.
22
23
24
26 --app=""
27 inspect a specific app
28
29
30 -d, --deffile[=false]
31 show the Singularity recipe file that was used to generate the
32 image
33
34
35 -e, --environment[=false]
36 show the environment settings for the image
37
38
39 -h, --help[=false]
40 help for inspect
41
42
43 -H, --helpfile[=false]
44 inspect the runscript helpfile, if it exists
45
46
47 -j, --json[=false]
48 print structured json instead of sections
49
50
51 -l, --labels[=false]
52 show the labels associated with the image (default)
53
54
55 --list-apps[=false]
56 list all apps in a container
57
58
59 -r, --runscript[=false]
60 show the runscript for the image
61
62
63 -t, --test[=false]
64 show the test script for the image
65
66
67
69 $ singularity inspect ubuntu.sif
70
71 If you want to list the applications (apps) installed in a container (located at
72 /scif/apps) you should run inspect command with --list-apps <container-image> flag.
73 ( See https://sci-f.github.io for more information on SCIF apps)
74
75 The following environment variables are available to you when called
76 from the shell inside the container. The top variables are relevant
77 to the active app (--app <app>) and the bottom available for all
78 apps regardless of the active app. Both sets of variables are also available during development (at build time).
79
80 ACTIVE APP ENVIRONMENT:
81 SCIF_APPNAME the name for the active application
82 SCIF_APPROOT the installation folder for the application created at /scif/apps/<app>
83 SCIF_APPMETA the application metadata folder
84 SCIF_APPDATA the data folder created for the application at /scif/data/<app>
85 SCIF_APPINPUT expected input folder within data base folder
86 SCIF_APPOUTPUT the output data folder within data base folder
87
88 SCIF_APPENV points to the application's custom environment.sh file in its metadata folder
89 SCIF_APPLABELS is the application's labels.json in the metadata folder
90 SCIF_APPBIN is the bin folder for the app, which is automatically added to the $PATH when the app is active
91 SCIF_APPLIB is the application's library folder that is added to the LD_LIBRARY_PATH
92 SCIF_APPRUN is the runscript
93 SCIF_APPHELP is the help file for the runscript
94 SCIF_APPTEST is the testing script (test.sh) associated with the applicatio
95 SCIF_APPNAME the name for the active application
96 SCIF_APPFILES the files section associated with the application that are added to
97
98
99 GLOBAL APP ENVIRONMENT:
100
101 SCIF_DATA scif defined data base for all apps (/scif/data)
102 SCIF_APPS scif defined install bases for all apps (/scif/apps)
103 SCIF_APPROOT_<app> root for application <app>
104 SCIF_APPDATA_<app> data root for application <app>
105
106 To list all your apps:
107
108 $ singularity inspect --list-apps ubuntu.sif
109
110 To list only labels in the json format from an image:
111
112 $ singularity inspect --json --labels ubuntu.sif
113
114 To verify you own a single application on your container image, use the --app <appname> flag:
115
116 $ singularity inspect --app <appname> ubuntu.sif
117
118
119
120
122 singularity(1)
123
124
125
127 21-Oct-2019 Auto generated by spf13/cobra
128
129
130
131Auto generated by spf13/cobra Oct 2019 singularity(1)