OptionalcaptureWhen true, capture child stdout/stderr and re-emit after completion. Useful for tests/CI. Default behavior is streaming via stdio: 'inherit'.
OptionaldebugLogs CLI internals when true.
Optionaldefaultdefault target environment (used if env is not provided)
token indicating a dotenv file
OptionaldynamicProgrammatic dynamic variables map. When provided, this takes precedence over GetDotenvOptions.dynamicPath.
Optionaldynamicpath to JS/TS module default-exporting an object keyed to dynamic variable functions
OptionalentropyOptionalentropyOptionalentropyOptionalenvtarget environment
Optionalexcludeexclude dynamic variables from loading
Optionalexcludeexclude environment-specific variables from loading
Optionalexcludeexclude global variables from loading
Optionalexcludeexclude private variables from loading
Optionalexcludeexclude public variables from loading
Optionalloadload dotenv variables to process.env
Optionalloglog loaded dotenv variables to logger
Optionalloggerlogger object (defaults to console)
Optionaloutputif populated, writes consolidated dotenv file to this path (follows dotenvExpand rules)
OptionalpathsA delimited string of paths to dotenv files.
OptionalpathsA delimiter string with which to split paths. Only used if
pathsDelimiterPattern is not provided.
OptionalpathsA regular expression pattern with which to split paths. Supersedes
pathsDelimiter.
Optionalprivatefilename token indicating private variables
OptionalredactRedaction (presentation): mask secret-like values in logs/trace.
OptionalredactOptionalscriptsScripts that can be executed from the CLI, either individually or via the batch subcommand.
OptionalshellDetermines how commands and scripts are executed. If false or
undefined, commands are executed as plain Javascript using the default
execa parser. If true, commands are executed using the default OS shell
parser. Otherwise the user may provide a specific shell string (e.g.
/bin/bash)
OptionalstrictStrict mode: fail the run when env validation issues are detected (schema or requiredKeys). Warns by default when false or unset.
OptionaluseReserved: config loader flag (no-op). The plugin-first host and generator paths already use the config loader/overlay pipeline unconditionally (no-op when no config files are present). This flag is accepted for forward compatibility but currently has no effect.
OptionalvarsA delimited string of key-value pairs declaratively specifying variables & values to be loaded in addition to any dotenv files.
OptionalvarsA string with which to split keys from values in vars. Only used if
varsDelimiterPattern is not provided.
OptionalvarsA regular expression pattern with which to split variable names from values
in vars. Supersedes varsAssignor.
OptionalvarsA string with which to split vars into key-value pairs. Only used if
varsDelimiterPattern is not provided.
OptionalvarsA regular expression pattern with which to split vars into key-value
pairs. Supersedes varsDelimiter.
OptionalwarnEntropy warnings (presentation): emit once-per-key warnings for high-entropy values.
Options passed programmatically to
getDotenvCli.