CLI Reference

Usage

Run a Vjer action from the project root:

vjer <action>

From the module without an installed console script:

python -m vjer <action>

The freeze action accepts an optional suffix argument. For example:

vjer freeze
vjer freeze ci

Vjer supports a small set of runtime environment variables that modify CLI behavior and configuration loading.

VJER_CFG - Override the configuration file name. Defaults to vjer.yml in the project root.
VJER_ENV - Determines the runtime environment. Defaults to local. - When set to local, Vjer requires VIRTUAL_ENV to be active.
VIRTUAL_ENV - Required when running locally in VJER_ENV=local.
VJER_PKG_INSTALLS - Space-separated packages installed with apt-get before action execution on Linux.
VJER_PIP_INSTALLS - Packages installed with pip before action execution.
VJER_PIP_INSTALL_FILE - A requirements file to install with pip before action execution.
VJER_PYPROJECT_BUILD - When set, Vjer installs the project from pyproject.toml using the configured build backend.
VJER_DOCKER_PUSH - Controls whether Docker images built by Docker build steps are pushed. - Default: true in non-local environments and false in VJER_ENV=local.
VJER_BUILD_NUM - Build number used to form build metadata and non-bumpver image tags. - Default: depends on the version provider.

Vjer also reads standard CI variables when available to determine the current branch and repository remote: