1singularity(1) singularity(1)
2
6 singularity-inspect - Show metadata for an image
7
11 singularity inspect [inspect options...]
12
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
26 --all[=false] show all available data (imply --json option)
27 --app="" inspect a specific app
30 -d, --deffile[=false] show the Singularity recipe file that was
33 used to generate the image
34 -e, --environment[=false] show the environment settings for the
37 image
38 -h, --help[=false] help for inspect
41 -H, --helpfile[=false] inspect the runscript helpfile, if it ex‐
44 ists
45 -j, --json[=false] print structured json instead of sections
48 -l, --labels[=false] show the labels for the image (default)
51 --list-apps[=false] list all apps in a container
54 -r, --runscript[=false] show the runscript for the image
57 -s, --startscript[=false] show the startscript for the image
60 -t, --test[=false] show the test script for the image
63
67 $ singularity inspect ubuntu.sif
68 If you want to list the applications (apps) installed in a container (located at
70 /scif/apps) you should run inspect command with --list-apps <container-image> flag.
71 ( See https://sci-f.github.io for more information on SCIF apps)
72 The following environment variables are available to you when called
74 from the shell inside the container. The top variables are relevant
75 to the active app (--app <app>) and the bottom available for all
76 apps regardless of the active app. Both sets of variables are also available during development (at build time).
77 ACTIVE APP ENVIRONMENT:
79 SCIF_APPNAME the name for the active application
80 SCIF_APPROOT the installation folder for the application created at /scif/apps/<app>
81 SCIF_APPMETA the application metadata folder
82 SCIF_APPDATA the data folder created for the application at /scif/data/<app>
83 SCIF_APPINPUT expected input folder within data base folder
84 SCIF_APPOUTPUT the output data folder within data base folder
85 SCIF_APPENV points to the application's custom environment.sh file in its metadata folder
87 SCIF_APPLABELS is the application's labels.json in the metadata folder
88 SCIF_APPBIN is the bin folder for the app, which is automatically added to the $PATH when the app is active
89 SCIF_APPLIB is the application's library folder that is added to the LD_LIBRARY_PATH
90 SCIF_APPRUN is the runscript
91 SCIF_APPHELP is the help file for the runscript
92 SCIF_APPTEST is the testing script (test.sh) associated with the applicatio
93 SCIF_APPNAME the name for the active application
94 SCIF_APPFILES the files section associated with the application that are added to
95 GLOBAL APP ENVIRONMENT:
98 SCIF_DATA scif defined data base for all apps (/scif/data)
100 SCIF_APPS scif defined install bases for all apps (/scif/apps)
101 SCIF_APPROOT_<app> root for application <app>
102 SCIF_APPDATA_<app> data root for application <app>
103 To list all your apps:
105 $ singularity inspect --list-apps ubuntu.sif
107 To list only labels in the json format from an image:
109 $ singularity inspect --json --labels ubuntu.sif
111 To verify you own a single application on your container image, use the --app <appname> flag:
113 $ singularity inspect --app <appname> ubuntu.sif
115
120 singularity(1)
121
125 22-Jun-2022 Auto generated by spf13/cobra
126Auto generated by spf13/cobra Jun 2022 singularity(1)