Synopsis

fcli tool fcli env [--no-comments] [--cmd-var=<cmdVarMode>] [--cmd-var-name=<cmdVarName>] [--format=<format>] [--home-var=<homeVarMode>] [--home-var-name=<homeVarName>] [--path=<pathMode>] [-v=<version>] [[-h] [--env-prefix=<prefix>] [--log-file=<logFile>] [--log-level=<logLevel>] [--log-mask=<level>] [--debug]]

Description

This command outputs environment variable definitions for a previously installed or registered fcli installation. Use --format to select output format (default: shell).

Examples: Shell: source <(fcli tool fcli env) PowerShell: fcli tool fcli env --format powershell | Invoke-Expression GitHub Actions: source <(fcli tool fcli env --format github) Manual copy/paste: fcli tool fcli env --format azure

Options

--cmd-var=<cmdVarMode>

Control whether *_CMD environment variable should be set (pointing to tool binary). Allowed values: include, exclude, auto. Default: auto.

--cmd-var-name=<cmdVarName>

Override the *_CMD environment variable name. By default, uses the primary tool prefix with _CMD suffix (e.g., SCANCENTRAL_CMD, FCLI_CMD).

--format=<format>

Output format for environment variable definitions. Allowed values: shell, powershell, cmd, github, azure, gitlab. Default value: shell.

--home-var=<homeVarMode>

Control whether *_HOME environment variable should be set (pointing to installation directory). Allowed values: include, exclude, auto. Default: auto.

--home-var-name=<homeVarName>

Override the *_HOME environment variable name. By default, uses the primary tool prefix with _HOME suffix (e.g., SCANCENTRAL_HOME, FCLI_HOME).

--no-comments

Suppress comments in output. When enabled, only environment variable definitions are output without usage comments or headers. Useful when combining output from multiple tools or when comments are generated at a higher level.

--path=<pathMode>

Control whether PATH environment variable should be updated. Allowed values: include, exclude, auto. Default: auto. Auto mode includes PATH update only if the tool’s bin directory is not already in the current PATH.

-v, --version=<version>

Tool version for which to generate environment variables. The specified tool version must have been previously installed using the 'install' command or registered via the 'register' command. Default: the tool version that was last installed or registered.

Generic fcli options (also see documentation link below)

--debug

Enable collection of debug logs.

--env-prefix=<prefix>

Prefix for resolving default option values. Default value: FCLI_DEFAULT.

-h, --help

Use 'fcli [command] -h' to display help for fcli (sub-)commands.

--log-file=<logFile>

Write log output to file. Default: ./fcli.log if logging is enabled.

--log-level=<logLevel>

Set logging level: TRACE, DEBUG, INFO, WARN, ERROR, NONE.

--log-mask=<level>

Log mask level: high, medium, low, none. Default: medium. Masking is done on a best-effort basis; no guarantee that all sensitive data will be masked.