@karmaniverous/get-dotenv
    Preparing search index...

    Interface GetDotenvCliGenerateOptions

    generateGetDotenvCli options. Defines local instance of the GetDotenv CLI and sets defaults that can be overridden by local getdotenv.config.json in projects that import the CLI.

    interface GetDotenvCliGenerateOptions {
        alias: string;
        capture?: boolean;
        debug?: boolean;
        defaultEnv?: string;
        description: string;
        dotenvToken: string;
        dynamic?: GetDotenvDynamic;
        dynamicPath?: string;
        entropyMinLength?: number;
        entropyThreshold?: number;
        entropyWhitelist?: string[];
        env?: string;
        excludeDynamic?: boolean;
        excludeEnv?: boolean;
        excludeGlobal?: boolean;
        excludePrivate?: boolean;
        excludePublic?: boolean;
        importMetaUrl: string;
        loadProcess?: boolean;
        log?: boolean;
        logger: Logger;
        outputPath?: string;
        paths?: string;
        pathsDelimiter?: string;
        pathsDelimiterPattern?: string;
        postHook?: GetDotenvCliPostHookCallback;
        preHook?: GetDotenvCliPreHookCallback;
        privateToken?: string;
        redact?: boolean;
        redactPatterns?: string[];
        scripts?: Scripts;
        shell?: string | boolean;
        strict?: boolean;
        useConfigLoader?: boolean;
        vars?: string;
        varsAssignor?: string;
        varsAssignorPattern?: string;
        varsDelimiter?: string;
        varsDelimiterPattern?: string;
        warnEntropy?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    alias capture? debug? defaultEnv? description dotenvToken dynamic? dynamicPath? entropyMinLength? entropyThreshold? entropyWhitelist? env? excludeDynamic? excludeEnv? excludeGlobal? excludePrivate? excludePublic? importMetaUrl loadProcess? log? logger outputPath? paths? pathsDelimiter? pathsDelimiterPattern? postHook? preHook? privateToken? redact? redactPatterns? scripts? shell? strict? useConfigLoader? vars? varsAssignor? varsAssignorPattern? varsDelimiter? varsDelimiterPattern? warnEntropy?

    Properties

    alias: string

    CLI alias. Should align with the bin property in package.json.

    capture?: boolean

    When true, capture child stdout/stderr and re-emit after completion. Useful for tests/CI. Default behavior is streaming via stdio: 'inherit'.

    debug?: boolean

    Logs CLI internals when true.

    defaultEnv?: string

    default target environment (used if env is not provided)

    description: string

    Cli description (appears in CLI help).

    dotenvToken: string

    token indicating a dotenv file

    dynamic?: GetDotenvDynamic

    Programmatic dynamic variables map. When provided, this takes precedence over GetDotenvOptions.dynamicPath.

    dynamicPath?: string

    path to JS/TS module default-exporting an object keyed to dynamic variable functions

    entropyMinLength?: number
    entropyThreshold?: number
    entropyWhitelist?: string[]
    env?: string

    target environment

    excludeDynamic?: boolean

    exclude dynamic variables from loading

    excludeEnv?: boolean

    exclude environment-specific variables from loading

    excludeGlobal?: boolean

    exclude global variables from loading

    excludePrivate?: boolean

    exclude private variables from loading

    excludePublic?: boolean

    exclude public variables from loading

    importMetaUrl: string

    The import.meta.url of the module generating the CLI.

    loadProcess?: boolean

    load dotenv variables to process.env

    log?: boolean

    log loaded dotenv variables to logger

    logger: Logger

    Logger object (defaults to console)

    outputPath?: string

    if populated, writes consolidated dotenv file to this path (follows dotenvExpand rules)

    paths?: string

    A delimited string of paths to dotenv files.

    pathsDelimiter?: string

    A delimiter string with which to split paths. Only used if pathsDelimiterPattern is not provided.

    pathsDelimiterPattern?: string

    A regular expression pattern with which to split paths. Supersedes pathsDelimiter.

    postHook?: GetDotenvCliPostHookCallback

    Executes side effects within the getDotenv context after executing CLI commands.

    preHook?: GetDotenvCliPreHookCallback

    Mutates inbound options & executes side effects within the getDotenv context before executing CLI commands.

    privateToken?: string

    filename token indicating private variables

    redact?: boolean

    Redaction (presentation): mask secret-like values in logs/trace.

    redactPatterns?: string[]
    scripts?: Scripts

    Scripts that can be executed from the CLI, either individually or via the batch subcommand.

    shell?: string | boolean

    Determines 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)

    strict?: boolean

    Strict mode: fail the run when env validation issues are detected (schema or requiredKeys). Warns by default when false or unset.

    useConfigLoader?: boolean

    Reserved: 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.

    vars?: string

    A delimited string of key-value pairs declaratively specifying variables & values to be loaded in addition to any dotenv files.

    varsAssignor?: string

    A string with which to split keys from values in vars. Only used if varsDelimiterPattern is not provided.

    varsAssignorPattern?: string

    A regular expression pattern with which to split variable names from values in vars. Supersedes varsAssignor.

    varsDelimiter?: string

    A string with which to split vars into key-value pairs. Only used if varsDelimiterPattern is not provided.

    varsDelimiterPattern?: string

    A regular expression pattern with which to split vars into key-value pairs. Supersedes varsDelimiter.

    warnEntropy?: boolean

    Entropy warnings (presentation): emit once-per-key warnings for high-entropy values.

    Settings

    Member Visibility

    On This Page

    Properties