CLI alias. Should align with the bin
property in package.json
.
Optional
captureWhen true, capture child stdout/stderr and re-emit after completion. Useful for tests/CI. Default behavior is streaming via stdio: 'inherit'.
Optional
debugLogs CLI internals when true.
Optional
defaultdefault target environment (used if env
is not provided)
Cli description (appears in CLI help).
token indicating a dotenv file
Optional
dynamicProgrammatic dynamic variables map. When provided, this takes precedence over GetDotenvOptions.dynamicPath.
Optional
dynamicpath to JS/TS module default-exporting an object keyed to dynamic variable functions
Optional
envtarget environment
Optional
excludeexclude dynamic variables from loading
Optional
excludeexclude environment-specific variables from loading
Optional
excludeexclude global variables from loading
Optional
excludeexclude private variables from loading
Optional
excludeexclude public variables from loading
The import.meta.url
of the module generating the CLI.
Optional
loadload dotenv variables to process.env
Optional
loglog loaded dotenv variables to logger
Logger object (defaults to console)
Optional
outputif populated, writes consolidated dotenv file to this path (follows dotenvExpand rules)
Optional
pathsA delimited string of paths to dotenv files.
Optional
pathsA delimiter string with which to split paths
. Only used if
pathsDelimiterPattern
is not provided.
Optional
pathsA regular expression pattern with which to split paths
. Supersedes
pathsDelimiter
.
Optional
postExecutes side effects within the getDotenv
context after executing CLI
commands.
Optional
preMutates inbound options & executes side effects within the getDotenv
context before executing CLI commands.
Optional
privatefilename token indicating private variables
Optional
scriptsScripts that can be executed from the CLI, either individually or via the batch subcommand.
Optional
shellDetermines 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
)
Optional
useReserved: 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.
Optional
varsA delimited string of key-value pairs declaratively specifying variables & values to be loaded in addition to any dotenv files.
Optional
varsA string with which to split keys from values in vars
. Only used if
varsDelimiterPattern
is not provided.
Optional
varsA regular expression pattern with which to split variable names from values
in vars
. Supersedes varsAssignor
.
Optional
varsA string with which to split vars
into key-value pairs. Only used if
varsDelimiterPattern
is not provided.
Optional
varsA regular expression pattern with which to split vars
into key-value
pairs. Supersedes varsDelimiter
.
generateGetDotenvCli
options. Defines local instance of the GetDotenv CLI and sets defaults that can be overridden by localgetdotenv.config.json
in projects that import the CLI.