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

    Interface RootOptionsShape

    Minimal root options shape shared by CLI and generator layers. Keep keys optional to respect exactOptionalPropertyTypes semantics.

    interface RootOptionsShape {
        capture?: boolean;
        command?: string;
        debug?: boolean;
        defaultEnv?: string;
        dotenvToken?: string;
        dynamicPath?: string;
        entropyMinLength?: number;
        entropyThreshold?: number;
        entropyWhitelist?: readonly string[];
        env?: string;
        excludeAll?: boolean;
        excludeDynamic?: boolean;
        excludeEnv?: boolean;
        excludeGlobal?: boolean;
        excludePrivate?: boolean;
        excludePublic?: boolean;
        loadProcess?: boolean;
        log?: boolean;
        outputPath?: string;
        paths?: string;
        pathsDelimiter?: string;
        pathsDelimiterPattern?: string;
        privateToken?: string;
        redact?: boolean;
        redactPatterns?: string[];
        scripts?: ScriptsTable<string | boolean>;
        shell?: string | boolean;
        strict?: boolean;
        trace?: boolean | string[];
        vars?: string;
        varsAssignor?: string;
        varsAssignorPattern?: string;
        varsDelimiter?: string;
        varsDelimiterPattern?: string;
        warnEntropy?: boolean;
    }
    Index

    Properties

    capture? command? debug? defaultEnv? dotenvToken? dynamicPath? entropyMinLength? entropyThreshold? entropyWhitelist? env? excludeAll? excludeDynamic? excludeEnv? excludeGlobal? excludePrivate? excludePublic? loadProcess? log? outputPath? paths? pathsDelimiter? pathsDelimiterPattern? privateToken? redact? redactPatterns? scripts? shell? strict? trace? vars? varsAssignor? varsAssignorPattern? varsDelimiter? varsDelimiterPattern? warnEntropy?

    Properties

    capture?: boolean

    Capture child process stdio (useful for tests/CI).

    command?: string

    Command to execute (dotenv-expanded).

    debug?: boolean

    Enable debug logging to stderr.

    defaultEnv?: string

    Default target environment when not specified.

    dotenvToken?: string

    Token indicating a dotenv file (default: ".env").

    dynamicPath?: string

    Path to dynamic variables module (default: undefined).

    entropyMinLength?: number

    Minimum string length to check for entropy (default 16).

    entropyThreshold?: number

    Entropy threshold (bits/char) for warnings (default 3.8).

    entropyWhitelist?: readonly string[]

    Regex patterns for keys to exclude from entropy checks.

    env?: string

    Target environment (dotenv-expanded).

    excludeAll?: boolean

    Exclude all variables from loading.

    excludeDynamic?: boolean

    Exclude dynamic variables.

    excludeEnv?: boolean

    Exclude environment-specific variables.

    excludeGlobal?: boolean

    Exclude global variables.

    excludePrivate?: boolean

    Exclude private variables.

    excludePublic?: boolean

    Exclude public variables.

    loadProcess?: boolean

    Whether to load variables into process.env.

    log?: boolean

    Enable console logging of loaded variables.

    outputPath?: string

    Output path for the consolidated environment file (dotenv-expanded).

    paths?: string

    Paths to search for dotenv files (space-delimited string or array).

    pathsDelimiter?: string

    Delimiter for paths string (default: space).

    pathsDelimiterPattern?: string

    Regex pattern for paths delimiter.

    privateToken?: string

    Token indicating private variables (default: "local").

    redact?: boolean

    Enable presentation-time redaction of secret-like keys.

    redactPatterns?: string[]

    Additional regex patterns for keys to redact.

    scripts?: ScriptsTable<string | boolean>

    Table of named scripts for execution.

    shell?: string | boolean

    Shell execution strategy.

    • true: use default OS shell.
    • false: use plain execution (no shell).
    • string: use specific shell path.
    strict?: boolean

    Fail on validation errors (schema/requiredKeys).

    trace?: boolean | string[]

    Emit diagnostics for child env composition.

    • true: trace all keys.
    • string[]: trace selected keys.
    vars?: string

    Explicit variable overrides (dotenv-expanded).

    varsAssignor?: string

    Assignment operator for vars (default: "=").

    varsAssignorPattern?: string

    Regex pattern for vars assignment operator.

    varsDelimiter?: string

    Delimiter for vars string (default: space).

    varsDelimiterPattern?: string

    Regex pattern for vars delimiter.

    warnEntropy?: boolean

    Enable entropy warnings for high-entropy values.

    Settings

    Member Visibility

    On This Page

    Properties