Command line interface

The following shows the full command help:

Initialize the environment

venvmod-initialize

usage: venvmod-initialize [-h] [--verbose]
                          [--modulefile-version modulefile_version]
                          [--activate-log activate_log] [--read-env]
                          VIRTUAL_ENV

Initialize Modulefile in venv.

positional arguments:
  VIRTUAL_ENV           Path to the virtual env to modify

options:
  -h, --help            show this help message and exit
  --verbose             To display the result.
  --modulefile-version modulefile_version
                        Modulefile version to use if not found or version <
                        4.6. It can be a source directory to avoid downloading
  --activate-log activate_log
                        Log message when the module is loaded.
  --read-env            Read environment variables. 'See cmd-read-env'

Manage submodules

venvmod-add-appli

usage: venvmod-add-appli [-h] [--verbose] [--read-env] [--disconnect]
                         VIRTUAL_ENV APPLI [APPLI ...]

Initialize Modulefile for an application.

positional arguments:
  VIRTUAL_ENV   Path to the virtual env to modify
  APPLI         Appli name(s) to add to the environment.

options:
  -h, --help    show this help message and exit
  --verbose     To display the result.
  --read-env    Read environment variables. 'See cmd-read-env'
  --disconnect  Disconnects applis loading at activate.

venvmod-rm-appli

usage: venvmod-rm-appli [-h] [--verbose] VIRTUAL_ENV APPLI [APPLI ...]

Delete Modulefile for an application.

positional arguments:
  VIRTUAL_ENV  Path to the virtual env to modify
  APPLI        Appli name(s) to add to the environment.

options:
  -h, --help   show this help message and exit
  --verbose    To display the result.

Modify the modules

venvmod-cmd-append-path

usage: venvmod-cmd-append-path [-h] [--verbose] [--appli appli]
                               VIRTUAL_ENV ENV_VAR PATH [PATH ...]

Append value to environment variable.

positional arguments:
  VIRTUAL_ENV    Path to the virtual env to modify
  ENV_VAR        Variable to append
  PATH           List of paths to append

options:
  -h, --help     show this help message and exit
  --verbose      To display the result.
  --appli appli  Name of the appli modulefile (case insensitive)

venvmod-cmd-module-load

usage: venvmod-cmd-module-load [-h] [--verbose] [--appli appli]
                               VIRTUAL_ENV MODULE [MODULE ...]

Load modulefile(s).

positional arguments:
  VIRTUAL_ENV    Path to the virtual env to modify
  MODULE         List of environment module to load

options:
  -h, --help     show this help message and exit
  --verbose      To display the result.
  --appli appli  Name of the appli modulefile (case insensitive)

venvmod-cmd-module-use

usage: venvmod-cmd-module-use [-h] [--verbose] [--appli appli]
                              VIRTUAL_ENV PATH [PATH ...]

Add dir(s) to MODULEPATH variable.

positional arguments:
  VIRTUAL_ENV    Path to the virtual env to modify
  PATH           List of paths to use to locate modules

options:
  -h, --help     show this help message and exit
  --verbose      To display the result.
  --appli appli  Name of the appli modulefile (case insensitive)

venvmod-cmd-prepend-path

usage: venvmod-cmd-prepend-path [-h] [--verbose] [--appli appli]
                                VIRTUAL_ENV ENV_VAR PATH [PATH ...]

Prepend value to environment variable.

positional arguments:
  VIRTUAL_ENV    Path to the virtual env to modify
  ENV_VAR        Variable to prepend
  PATH           List of paths to prepend

options:
  -h, --help     show this help message and exit
  --verbose      To display the result.
  --appli appli  Name of the appli modulefile (case insensitive)

venvmod-cmd-read-env

usage: venvmod-cmd-read-env [-h] [--verbose] [--appli appli] VIRTUAL_ENV

Read environment variable to extend modulefile.

positional arguments:
  VIRTUAL_ENV    Path to the virtual env to modify

options:
  -h, --help     show this help message and exit
  --verbose      To display the result.
  --appli appli  Name of the appli modulefile (case insensitive)

venvmod-cmd-remove-path

usage: venvmod-cmd-remove-path [-h] [--verbose] [--appli appli]
                               VIRTUAL_ENV VARIABLE PATH

Remove value from environment variable.

positional arguments:
  VIRTUAL_ENV    Path to the virtual env to modify
  VARIABLE       Environment variable to modify
  PATH           Path to remove from variable

options:
  -h, --help     show this help message and exit
  --verbose      To display the result.
  --appli appli  Name of the appli modulefile (case insensitive)

venvmod-cmd-setenv

usage: venvmod-cmd-setenv [-h] [--verbose] [--appli appli]
                          VIRTUAL_ENV VARIABLE VALUE

Define environment variable.

positional arguments:
  VIRTUAL_ENV    Path to the virtual env to modify
  VARIABLE       Environment variable to define
  VALUE          Value associated to the variable

options:
  -h, --help     show this help message and exit
  --verbose      To display the result.
  --appli appli  Name of the appli modulefile (case insensitive)

venvmod-cmd-set-alias

usage: venvmod-cmd-set-alias [-h] [--verbose] [--appli appli]
                             VIRTUAL_ENV ALIAS VALUE

Define aliases.

positional arguments:
  VIRTUAL_ENV    Path to the virtual env to modify
  ALIAS          Alias name
  VALUE          Alias value

options:
  -h, --help     show this help message and exit
  --verbose      To display the result.
  --appli appli  Name of the appli modulefile (case insensitive)

venvmod-cmd-source-sh

usage: venvmod-cmd-source-sh [-h] [--verbose] [--appli appli]
                             VIRTUAL_ENV SHELL SCRIPT [ARG ...]

Script(s) to source.

positional arguments:
  VIRTUAL_ENV    Path to the virtual env to modify
  SHELL          Shell name
  SCRIPT         Script path
  ARG            Script arguments

options:
  -h, --help     show this help message and exit
  --verbose      To display the result.
  --appli appli  Name of the appli modulefile (case insensitive)

venvmod-test-import

usage: venvmod-test-import [-h] [--verbose] VIRTUAL_ENV MODULE [MODULE ...]

Test module import.

positional arguments:
  VIRTUAL_ENV  Path to the virtual env to modify
  MODULE       List of Python modules to test.

options:
  -h, --help   show this help message and exit
  --verbose    To display the result.