flux(1)

SYNOPSIS

flux [OPTIONS] CMD [CMD-OPTIONS]

DESCRIPTION

Flux is a modular framework for resource management.

flux is a front end for Flux sub-commands. flux -h summarizes the core Flux commands. flux help CMD displays the manual page for CMD.

If CMD contains a slash "/" character, it is executed directly, bypassing the sub-command search path.

OPTIONS

-h, --help

Display help on options, and a list of the core Flux sub-commands.

-p, --parent

If current instance is a child, connect to parent instead. Also sets FLUX_KVS_NAMESPACE if current instance is confined to a KVS namespace in the parent. This option may be specified multiple times.

-v, --verbose

Display command environment, and the path search for CMD.

-V, --version

Convenience option to run flux-version(1).

SUB-COMMAND ENVIRONMENT

flux uses compiled-in install paths and its environment to construct the environment for sub-commands. More detail is available in the flux-environment(7) SUB-COMMAND ENVIRONMENT section. A summary is provided below:

Name

Description

FLUX_EXEC_PATH

where to look for "flux-CMD" executables

FLUX_MODULE_PATH

directories to look for broker modules

FLUX_CONNECTOR_PATH

directories to search for connector modules

LUA_PATH

Lua module search path

LUA_CPATH

Lua binary module search path

PYTHONPATH

Python module search path:

RESOURCES

Flux: http://flux-framework.org

Flux RFC: https://flux-framework.readthedocs.io/projects/flux-rfc