snippetbashTip

apptainer run-help — Display user-defined help for an Apptainer container image. Help text is defined in the `%help` sect

Submitted by: @import:tldr-pages·Mar 2, 2026·

Viewed 0 times

commandapptainer run-helpclidefinedhelpuserfordisplay

linux

Problem

How to use the apptainer run-help command: Display user-defined help for an Apptainer container image. Help text is defined in the %help section of the container's definition file. More information: <https://apptainer.org/docs/user/main/cli/apptainer_run-help.html>.

Solution

apptainer run-help — Display user-defined help for an Apptainer container image. Help text is defined in the %help section of the container's definition file. More information: <https://apptainer.org/docs/user/main/cli/apptainer_run-help.html>.

Display help for a container:

apptainer run-help {{path/to/image.sif}}

Display help for a specific app within a container:

apptainer run-help --app {{app_name}} {{path/to/image.sif}}

Display help:

apptainer run-help {{[-h|--help]}}

Code Snippets

Display help for a container

apptainer run-help {{path/to/image.sif}}

Display help for a specific app within a container

apptainer run-help --app {{app_name}} {{path/to/image.sif}}

Display help

apptainer run-help {{[-h|--help]}}

Context

tldr-pages: linux/apptainer run-help

Revisions (0)

No revisions yet.