apptainer run

linux

Run the default runscript of an Apptainer container. The runscript is defined in the `%runscript` section of the container's definition file. See also: `apptainer exec`, `apptainer shell`.

More info →

Subcommands (1)

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.

→

Options (3)

-B, --bindboolean

Run with a bind mount from host to container

Example: apptainer run {{[-B|--bind]}} {{path/to/source}}:{{path/to/destination}} {{path/to/image.sif}}

-C, --containallboolean

Run in fully isolated mode (contained filesystem, PID, IPC, and clean environment)

Example: apptainer run {{[-C|--containall]}} {{path/to/image.sif}}

-h, --helpboolean

Display help

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

Examples (8)

Run the default runscript of a container

apptainer run path/to/image.sif

Run with arguments passed to the runscript

apptainer run path/to/image.sif arg1 arg2 ...

Run with a bind mount from host to container

apptainer run [-B|--bind] path/to/source:path/to/destination path/to/image.sif

Run with environment variables

apptainer run --env variable=value path/to/image.sif

Run in fully isolated mode (contained filesystem, PID, IPC, and clean environment)

apptainer run [-C|--containall] path/to/image.sif

Run with a writable temporary filesystem overlay

apptainer run --writable-tmpfs path/to/image.sif

Run with NVIDIA GPU support

apptainer run --nv path/to/image.sif

Display help

apptainer run [-h|--help]

made by @shridhargupta | data from tldr-pages