1apptainer(1)                                                      apptainer(1)
2
3
4

NAME

6       apptainer-inspect - Show metadata for an image
7
8
9

SYNOPSIS

11       apptainer inspect [inspect options...]
12
13
14

DESCRIPTION

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

OPTIONS

26       --all[=false]      show all available data (imply --json option)
27
28
29       --app=""      inspect a specific app
30
31
32       -d, --deffile[=false]      show the Apptainer definition file that  was
33       used to generate the image
34
35
36       -e,  --environment[=false]       show  the environment settings for the
37       image
38
39
40       -h, --help[=false]      help for inspect
41
42
43       -H, --helpfile[=false]      inspect the runscript helpfile, if  it  ex‐
44       ists
45
46
47       -j, --json[=false]      print structured json instead of sections
48
49
50       -l, --labels[=false]      show the labels for the image (default)
51
52
53       --list-apps[=false]      list all apps in a container
54
55
56       -r, --runscript[=false]      show the runscript for the image
57
58
59       -s, --startscript[=false]      show the startscript for the image
60
61
62       -t, --test[=false]      show the test script for the image
63
64
65

EXAMPLE

67                $ apptainer inspect ubuntu.sif
68
69                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
73                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
78                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
86                    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_APPSTART      is the startscript
92                    SCIF_APPHELP       is the help file for the runscript
93                    SCIF_APPTEST       is the testing script (test.sh) associated with the application
94                    SCIF_APPNAME       the name for the active application
95                    SCIF_APPFILES      the files section associated with the application that are added to
96
97
98                GLOBAL APP ENVIRONMENT:
99
100                    SCIF_DATA             scif defined data base for all apps (/scif/data)
101                    SCIF_APPS             scif defined install bases for all apps (/scif/apps)
102                    SCIF_APPROOT_<app>    root for application <app>
103                    SCIF_APPDATA_<app>    data root for application <app>
104
105                To list all your apps:
106
107                $ apptainer inspect --list-apps ubuntu.sif
108
109                To list only labels in the json format from an image:
110
111                $ apptainer inspect --json --labels ubuntu.sif
112
113                To verify you own a single application on your container image, use the --app <appname> flag:
114
115                $ apptainer inspect --app <appname> ubuntu.sif
116
117
118
119

SEE ALSO

121       apptainer(1)
122
123
124

HISTORY

126       22-Nov-2023 Auto generated by spf13/cobra
127
128
129
130Auto generated by spf13/cobra      Nov 2023                       apptainer(1)