module

Display available modules

$ module avail

$ module avail [module_name]

$ module load [module_name]

$ module list

$ module unload [module_name]

$ module purge

$ module save [collection_name]

$ module restore [collection_name]

module [switches] sub-command [sub-command-args]

module provides a user interface to the Environment Modules package, enabling dynamic modification of the shell environment through modulefiles. Each modulefile contains configuration for applications, typically modifying PATH, MANPATH, LDLIBRARYPATH, and other environment variables.
The system allows users to load and unload software configurations without manual environment variable management. Modulefiles are interpreted as Tcl scripts and can set variables, create aliases, and define dependencies.
Collections allow saving and restoring sets of loaded modules, useful for switching between project configurations or workflows.

avail [_pattern_]

List available modulefiles matching optional pattern

Load modules into the current environment

Remove modules from the environment

List currently loaded modules

Unload all loaded modules

Unload then reload all modules

Replace one module with another

Save current environment state to collection

Restore saved environment collection

List saved collections

Show modulefile contents and effects

Search modulefile descriptions

Add directories to modulefile search path

Output in JSON format

Long format output

Short format output

Enable verbose messages

Modulefiles must begin with the magic cookie #%Module. Loading conflicting modules may cause unexpected behavior unless dependencies are properly defined. The module command modifies the current shell environment; changes are lost when the shell exits unless saved to shell initialization files.

The Environment Modules system originated at DOE computing facilities in the early 1990s. Lmod, a Lua-based implementation, was developed at the Texas Advanced Computing Center (TACC) and is widely used on HPC systems. Both provide compatible user interfaces for managing software environments.

modulefile(5), ml(1)