@karmaniverous/get-dotenv 6.1.1 → 6.2.1

package/dist/plugins-batch.mjs

@@ -21,26 +21,58 @@ import { globby } from 'globby';
  * Minimal process env representation used by options and helpers.
  * Values may be `undefined` to indicate "unset".
  */
+/**
+ * Schema for an env-like record.
+ *
+ * Keys are environment variable names and values are either strings or `undefined`
+ * (to represent “unset”).
+ *
+ * @public
+ */
 const processEnvSchema = z.record(z.string(), z.string().optional());
 // RAW: all fields optional — undefined means "inherit" from lower layers.
+/**
+ * Programmatic options schema (raw).
+ *
+ * This schema is the canonical runtime source of truth for the `getDotenv()` programmatic API.
+ * All fields are optional; `undefined` generally means “inherit default/lower layer”.
+ *
+ * @public
+ */
 const getDotenvOptionsSchemaRaw = z.object({
+    /** Default environment name when `env` is not provided. */
     defaultEnv: z.string().optional(),
+    /** Base dotenv filename token (default `.env`). */
     dotenvToken: z.string().optional(),
+    /** Path to a dynamic variables module (JS/TS) to load and apply. */
     dynamicPath: z.string().optional(),
-    // Dynamic map is intentionally wide for now; refine once sources are normalized.
+    /** Dynamic map is intentionally wide for now; refine once sources are normalized. */
     dynamic: z.record(z.string(), z.unknown()).optional(),
+    /** Selected environment name for this invocation (for env-scoped files and overlays). */
     env: z.string().optional(),
+    /** When true, skip applying dynamic variables. */
     excludeDynamic: z.boolean().optional(),
+    /** When true, skip environment-scoped dotenv files. */
     excludeEnv: z.boolean().optional(),
+    /** When true, skip global dotenv files. */
     excludeGlobal: z.boolean().optional(),
+    /** When true, skip private dotenv files. */
     excludePrivate: z.boolean().optional(),
+    /** When true, skip public dotenv files. */
     excludePublic: z.boolean().optional(),
+    /** When true, merge the final composed environment into `process.env`. */
     loadProcess: z.boolean().optional(),
+    /** When true, log the final environment map via `logger`. */
     log: z.boolean().optional(),
+    /** Logger used when `log` is enabled (console-compatible). */
     logger: z.unknown().default(console),
+    /** Optional output dotenv file path to write after composition. */
     outputPath: z.string().optional(),
+    /** Dotenv search paths (ordered). */
     paths: z.array(z.string()).optional(),
+    /** Private token suffix for private dotenv files (default `local`). */
     privateToken: z.string().optional(),
+    /** Explicit variables to overlay onto the composed dotenv map. */
     vars: processEnvSchema.optional(),
 });
 /**
@@ -48,6 +80,14 @@ const getDotenvOptionsSchemaRaw = z.object({
  * For now, this mirrors the RAW schema; future stages may materialize defaults
  * and narrow shapes as resolution is wired into the host.
  */
+/**
+ * Programmatic options schema (resolved).
+ *
+ * Today this mirrors {@link getDotenvOptionsSchemaRaw}, but is kept as a distinct export
+ * so future resolution steps can narrow or materialize defaults without breaking the API.
+ *
+ * @public
+ */
 const getDotenvOptionsSchemaResolved = getDotenvOptionsSchemaRaw;
 
 /**
@@ -57,27 +97,55 @@ const getDotenvOptionsSchemaResolved = getDotenvOptionsSchemaRaw;
  * reflect normalized types (paths: string[], vars: ProcessEnv), applied in the
  * CLI resolution pipeline.
  */
+/**
+ * CLI options schema (raw).
+ *
+ * Extends the programmatic options schema with CLI-only flags and stringly inputs
+ * which are normalized later by the host resolution pipeline.
+ *
+ * @public
+ */
 const getDotenvCliOptionsSchemaRaw = getDotenvOptionsSchemaRaw.extend({
     // CLI-specific fields (stringly inputs before preprocessing)
+    /** Enable verbose debug output (host-specific). */
     debug: z.boolean().optional(),
+    /** Fail on validation errors (schema/requiredKeys). */
     strict: z.boolean().optional(),
+    /** Capture child process stdio (useful for CI/tests). */
     capture: z.boolean().optional(),
+    /** Emit child env diagnostics (boolean or selected keys). */
     trace: z.union([z.boolean(), z.array(z.string())]).optional(),
+    /** Enable presentation-time redaction in trace/log output. */
     redact: z.boolean().optional(),
+    /** Enable entropy warnings in trace/log output. */
     warnEntropy: z.boolean().optional(),
+    /** Entropy threshold (bits/char) for warnings. */
     entropyThreshold: z.number().optional(),
+    /** Minimum value length to consider for entropy warnings. */
     entropyMinLength: z.number().optional(),
+    /** Regex patterns (strings) to suppress entropy warnings by key. */
     entropyWhitelist: z.array(z.string()).optional(),
+    /** Additional key-match patterns (strings) for redaction. */
     redactPatterns: z.array(z.string()).optional(),
+    /** Dotenv search paths provided as a single delimited string. */
     paths: z.string().optional(),
+    /** Delimiter string used to split `paths`. */
     pathsDelimiter: z.string().optional(),
+    /** Regex pattern used to split `paths` (takes precedence over delimiter). */
     pathsDelimiterPattern: z.string().optional(),
+    /** Scripts table in a permissive shape at parse time (validated elsewhere). */
     scripts: z.record(z.string(), z.unknown()).optional(),
+    /** Shell selection (`false` for shell-off, string for explicit shell). */
     shell: z.union([z.boolean(), z.string()]).optional(),
+    /** Extra variables expressed as a single delimited string of assignments. */
     vars: z.string().optional(),
+    /** Assignment operator used when parsing `vars`. */
     varsAssignor: z.string().optional(),
+    /** Regex pattern used as the assignment operator for `vars` parsing. */
     varsAssignorPattern: z.string().optional(),
+    /** Delimiter string used to split `vars`. */
     varsDelimiter: z.string().optional(),
+    /** Regex pattern used to split `vars` (takes precedence over delimiter). */
     varsDelimiterPattern: z.string().optional(),
 });
 
@@ -101,17 +169,34 @@ const envStringMap = z.record(z.string(), stringMap);
  * Raw configuration schema for get‑dotenv config files (JSON/YAML/JS/TS).
  * Validates allowed top‑level keys without performing path normalization.
  */
+/**
+ * Config schema for discovered get-dotenv configuration documents (raw).
+ *
+ * This schema validates the allowed top-level keys for configuration files.
+ * It does not normalize paths or coerce types beyond Zod’s parsing.
+ *
+ * @public
+ */
 const getDotenvConfigSchemaRaw = z.object({
+    /** Root option defaults applied by the host (CLI-like, collapsed families). */
     rootOptionDefaults: getDotenvCliOptionsSchemaRaw.optional(),
+    /** Help-time visibility map for root flags (false hides). */
     rootOptionVisibility: visibilityMap.optional(),
-    scripts: z.record(z.string(), z.unknown()).optional(), // Scripts validation left wide; generator validates elsewhere
+    /** Scripts table used by cmd/batch resolution (validation intentionally permissive here). */
+    scripts: z.record(z.string(), z.unknown()).optional(),
+    /** Keys required to be present in the final composed environment. */
     requiredKeys: z.array(z.string()).optional(),
+    /** Validation schema (JS/TS only; JSON/YAML loader rejects). */
     schema: z.unknown().optional(), // JS/TS-only; loader rejects in JSON/YAML
+    /** Public global variables (string-only). */
     vars: stringMap.optional(), // public, global
+    /** Public per-environment variables (string-only). */
     envVars: envStringMap.optional(), // public, per-env
     // Dynamic in config (JS/TS only). JSON/YAML loader will reject if set.
+    /** Dynamic variable definitions (JS/TS only). */
     dynamic: z.unknown().optional(),
     // Per-plugin config bag; validated by plugins/host when used.
+    /** Per-plugin config slices keyed by realized mount path (for example, `aws/whoami`). */
     plugins: z.record(z.string(), z.unknown()).optional(),
 });
 /**
@@ -863,13 +948,21 @@ const redactObject = (obj, opts) => {
  * Base root CLI defaults (shared; kept untyped here to avoid cross-layer deps).
  * Used as the bottom layer for CLI option resolution.
  */
+const baseScripts = {
+    'git-status': {
+        cmd: 'git branch --show-current && git status -s -u',
+        shell: true,
+    },
+};
 /**
- * Default values for root CLI options used by the host and helpers as the
- * baseline layer during option resolution.
+ * Default values for root CLI options used by the host and helpers as the baseline layer during option resolution.
+ *
+ * These defaults correspond to the “stringly” root surface (see `RootOptionsShape`) and are merged by precedence with:
+ * - create-time overrides
+ * - any discovered configuration `rootOptionDefaults`
+ * - and finally CLI flags at runtime
  *
- * These defaults correspond to the "stringly" root surface (see `RootOptionsShape`)
- * and are merged by precedence with create-time overrides and any discovered
- * configuration `rootOptionDefaults` before CLI flags are applied.
+ * @public
  */
 const baseRootOptionDefaults = {
     dotenvToken: '.env',
@@ -883,12 +976,7 @@ const baseRootOptionDefaults = {
     paths: './',
     pathsDelimiter: ' ',
     privateToken: 'local',
-    scripts: {
-        'git-status': {
-            cmd: 'git branch --show-current && git status -s -u',
-            shell: true,
-        },
-    },
+    scripts: baseScripts,
     shell: true,
     vars: '',
     varsAssignor: '=',
@@ -1430,6 +1518,14 @@ async function _execNormalized(command, shell, opts = {}) {
         return out;
     }
 }
+/**
+ * Execute a command and return its exit code.
+ *
+ * @param command - Command string (shell) or argv array (shell-off supported).
+ * @param shell - Shell setting (false for plain execution).
+ * @param opts - Execution options (cwd/env/stdio).
+ * @returns A promise resolving to the process exit code.
+ */
 async function runCommand(command, shell, opts) {
     // Build opts without injecting undefined (exactOptionalPropertyTypes-safe)
     const callOpts = {};
@@ -1889,6 +1985,16 @@ function evaluateDynamicOptions(root, resolved) {
     visit(root);
 }
 
+/**
+ * Initialize a {@link GetDotenvCli} instance with help configuration and safe defaults.
+ *
+ * @remarks
+ * This is a low-level initializer used by the host constructor to keep `GetDotenvCli.ts`
+ * small and to centralize help/output behavior.
+ *
+ * @param cli - The CLI instance to initialize.
+ * @param headerGetter - Callback returning an optional help header string.
+ */
 function initializeInstance(cli, headerGetter) {
     // Configure grouped help: show only base options in default "Options";
     // subcommands show all of their own options.
@@ -2856,7 +2962,9 @@ function attachBatchOptions(plugin, cli) {
 const ScriptSchema = z.union([
     z.string(),
     z.object({
+        /** Command string to execute. */
         cmd: z.string(),
+        /** Optional shell override for this script entry. */
         shell: z.union([z.string(), z.boolean()]).optional(),
     }),
 ]);
@@ -2864,10 +2972,15 @@ const ScriptSchema = z.union([
  * Zod schema for batch plugin configuration.
  */
 const batchPluginConfigSchema = z.object({
+    /** Optional scripts table scoped to the batch plugin. */
     scripts: z.record(z.string(), ScriptSchema).optional(),
+    /** Optional default shell for batch execution (overridden by per-script shell when present). */
     shell: z.union([z.string(), z.boolean()]).optional(),
+    /** Root path for discovery, relative to CWD (or package root when pkgCwd is true). */
     rootPath: z.string().optional(),
+    /** Space-delimited glob patterns used to discover directories. */
     globs: z.string().optional(),
+    /** When true, resolve the batch root from the nearest package directory. */
     pkgCwd: z.boolean().optional(),
 });
 

package/dist/plugins-cmd.d.ts

@@ -20,9 +20,21 @@ type ScriptsTable<TShell extends string | boolean = string | boolean> = Record<s
  * @public
  */
 interface GetDotenvCliCtx<TOptions extends GetDotenvOptions = GetDotenvOptions> {
+    /**
+     * Fully resolved option bag used to compute this context.
+     */
     optionsResolved: TOptions;
+    /**
+     * Final composed dotenv environment for this invocation.
+     */
     dotenv: ProcessEnv;
+    /**
+     * Optional runtime plugin state bag. Plugins may publish non-sensitive metadata here.
+     */
     plugins?: Record<string, unknown>;
+    /**
+     * Per-plugin validated configuration slices keyed by realized mount path.
+     */
     pluginConfigs?: Record<string, unknown>;
 }
 
@@ -31,6 +43,14 @@ interface GetDotenvCliCtx<TOptions extends GetDotenvOptions = GetDotenvOptions>
  * For the current step this mirrors the RAW schema; later stages may further
  * narrow types post-resolution in the host pipeline.
  */
+/**
+ * CLI options schema (resolved).
+ *
+ * Today this mirrors {@link getDotenvCliOptionsSchemaRaw}, but is kept as a distinct export
+ * so future resolution steps can narrow or materialize defaults without breaking the API.
+ *
+ * @public
+ */
 declare const getDotenvCliOptionsSchemaResolved: z.ZodObject<{
     defaultEnv: z.ZodOptional<z.ZodString>;
     dotenvToken: z.ZodOptional<z.ZodString>;
@@ -74,6 +94,14 @@ declare const getDotenvCliOptionsSchemaResolved: z.ZodObject<{
  * For now, this mirrors the RAW schema; future stages may materialize defaults
  * and narrow shapes as resolution is wired into the host.
  */
+/**
+ * Programmatic options schema (resolved).
+ *
+ * Today this mirrors {@link getDotenvOptionsSchemaRaw}, but is kept as a distinct export
+ * so future resolution steps can narrow or materialize defaults without breaking the API.
+ *
+ * @public
+ */
 declare const getDotenvOptionsSchemaResolved: z.ZodObject<{
     defaultEnv: z.ZodOptional<z.ZodString>;
     dotenvToken: z.ZodOptional<z.ZodString>;
@@ -128,7 +156,7 @@ type Logger = Record<string, (...args: unknown[]) => void> | typeof console;
  * Canonical programmatic options type (schema-derived).
  * This type is the single source of truth for programmatic options.
  */
-type GetDotenvOptions = z.output<typeof getDotenvOptionsSchemaResolved> & {
+type GetDotenvOptions = Omit<z.output<typeof getDotenvOptionsSchemaResolved>, 'logger' | 'dynamic'> & {
     /**
      * Compile-time overlay: narrowed logger for DX (schema stores unknown).
      */
@@ -149,11 +177,15 @@ type Scripts = ScriptsTable;
  * stringly paths/vars, and inherited programmatic fields (minus normalized
  * shapes that are handled by resolution).
  */
-type GetDotenvCliOptions = z.output<typeof getDotenvCliOptionsSchemaResolved> & {
+type GetDotenvCliOptions = Omit<z.output<typeof getDotenvCliOptionsSchemaResolved>, 'logger' | 'dynamic' | 'scripts'> & {
     /**
      * Compile-only overlay for DX: logger narrowed from unknown.
      */
     logger: Logger;
+    /**
+     * Compile-only overlay for DX: dynamic map narrowed from unknown.
+     */
+    dynamic?: GetDotenvDynamic;
     /**
      * Compile-only overlay for DX: scripts narrowed from Record\<string, unknown\>.
      */
@@ -216,13 +248,37 @@ interface GetDotenvCliPublic<TOptions extends GetDotenvOptions = GetDotenvOption
     getCtx(): GetDotenvCliCtx<TOptions>;
     /** Check whether a context has been resolved (non-throwing). */
     hasCtx(): boolean;
+    /**
+     * Resolve options and compute the dotenv context for this invocation.
+     *
+     * @param customOptions - Partial options to overlay for this invocation.
+     * @param opts - Optional resolver behavior switches (for example, whether to run `afterResolve`).
+     * @returns A promise resolving to the computed invocation context.
+     */
     resolveAndLoad(customOptions?: Partial<TOptions>, opts?: ResolveAndLoadOptions): Promise<GetDotenvCliCtx<TOptions>>;
+    /**
+     * Tag an option with a help group identifier for grouped root help rendering.
+     *
+     * @param opt - The Commander option to tag.
+     * @param group - Group identifier (for example, `base`, `app`, or `plugin:<name>`).
+     * @returns Nothing.
+     */
     setOptionGroup(opt: Option, group: string): void;
     /**
      * Create a dynamic option whose description is computed at help time
      * from the resolved configuration.
      */
+    /**
+     * Create a dynamic option whose description is computed at help time from the resolved configuration.
+     *
+     * @param flags - Commander option flags usage string.
+     * @param desc - Description builder called during help rendering with the resolved help config.
+     * @param parser - Optional argument parser.
+     * @param defaultValue - Optional default value.
+     * @returns A Commander `Option` instance with a dynamic description.
+     */
     createDynamicOption<Usage extends string>(flags: Usage, desc: (cfg: ResolvedHelpConfig) => string, parser?: (value: string, previous?: unknown) => unknown, defaultValue?: unknown): Option<Usage>;
+    /** {@inheritDoc} */
     createDynamicOption<Usage extends string, TValue = unknown>(flags: Usage, desc: (cfg: ResolvedHelpConfig) => string, parser: (value: string, previous?: TValue) => TValue, defaultValue?: TValue): Option<Usage>;
 }
 /**
@@ -285,7 +341,27 @@ interface GetDotenvCliPlugin<TOptions extends GetDotenvOptions = GetDotenvOption
  * return types from definePlugin provide stronger DX for shipped/typed plugins.
  */
 interface PluginWithInstanceHelpers<TOptions extends GetDotenvOptions = GetDotenvOptions, TConfig = unknown, TArgs extends unknown[] = [], TOpts extends OptionValues = {}, TGlobal extends OptionValues = {}> extends GetDotenvCliPlugin<TOptions, TArgs, TOpts, TGlobal> {
+    /**
+     * Read the validated (and interpolated) configuration slice for this plugin instance.
+     *
+     * @param cli - The plugin mount (or any command under this mount) used to resolve the invocation context.
+     * @returns The plugin configuration slice, typed as `TCfg`.
+     * @throws Error when called before the host has resolved the invocation context.
+     */
     readConfig<TCfg = TConfig>(cli: GetDotenvCliPublic<TOptions, unknown[], OptionValues, OptionValues>): Readonly<TCfg>;
+    /**
+     * Create a Commander option whose help-time description receives the resolved root help config
+     * and this plugin instance’s validated configuration slice.
+     *
+     * @typeParam TCfg - The plugin configuration slice type.
+     * @typeParam Usage - The Commander usage string for the option flags.
+     * @param cli - The plugin mount used to associate the option with a realized mount path.
+     * @param flags - Commander option flags usage string.
+     * @param desc - Description builder receiving the resolved help config and the plugin config slice.
+     * @param parser - Optional argument parser.
+     * @param defaultValue - Optional default value.
+     * @returns A Commander `Option` instance with a dynamic description.
+     */
     createPluginDynamicOption<TCfg = TConfig, Usage extends string = string>(cli: GetDotenvCliPublic<TOptions, unknown[], OptionValues, OptionValues>, flags: Usage, desc: (cfg: ResolvedHelpConfig, pluginCfg: Readonly<TCfg>) => string, parser?: (value: string, previous?: unknown) => unknown, defaultValue?: unknown): Option<Usage>;
 }
 
@@ -342,6 +418,11 @@ interface RunCmdWithContextOptions {
 declare const cmdPlugin: (options?: CmdPluginOptions) => PluginWithInstanceHelpers<GetDotenvOptions, {
     expand?: boolean | undefined;
 }, [], {}, {}>;
+/**
+ * Cmd plugin instance type returned by {@link cmdPlugin}.
+ *
+ * @public
+ */
 type CmdPlugin = ReturnType<typeof cmdPlugin>;
 
 export { cmdPlugin };

package/dist/plugins-cmd.mjs

@@ -20,26 +20,58 @@ import { Option, Command } from '@commander-js/extra-typings';
  * Minimal process env representation used by options and helpers.
  * Values may be `undefined` to indicate "unset".
  */
+/**
+ * Schema for an env-like record.
+ *
+ * Keys are environment variable names and values are either strings or `undefined`
+ * (to represent “unset”).
+ *
+ * @public
+ */
 const processEnvSchema = z.record(z.string(), z.string().optional());
 // RAW: all fields optional — undefined means "inherit" from lower layers.
+/**
+ * Programmatic options schema (raw).
+ *
+ * This schema is the canonical runtime source of truth for the `getDotenv()` programmatic API.
+ * All fields are optional; `undefined` generally means “inherit default/lower layer”.
+ *
+ * @public
+ */
 const getDotenvOptionsSchemaRaw = z.object({
+    /** Default environment name when `env` is not provided. */
     defaultEnv: z.string().optional(),
+    /** Base dotenv filename token (default `.env`). */
     dotenvToken: z.string().optional(),
+    /** Path to a dynamic variables module (JS/TS) to load and apply. */
     dynamicPath: z.string().optional(),
-    // Dynamic map is intentionally wide for now; refine once sources are normalized.
+    /** Dynamic map is intentionally wide for now; refine once sources are normalized. */
     dynamic: z.record(z.string(), z.unknown()).optional(),
+    /** Selected environment name for this invocation (for env-scoped files and overlays). */
     env: z.string().optional(),
+    /** When true, skip applying dynamic variables. */
     excludeDynamic: z.boolean().optional(),
+    /** When true, skip environment-scoped dotenv files. */
     excludeEnv: z.boolean().optional(),
+    /** When true, skip global dotenv files. */
     excludeGlobal: z.boolean().optional(),
+    /** When true, skip private dotenv files. */
     excludePrivate: z.boolean().optional(),
+    /** When true, skip public dotenv files. */
     excludePublic: z.boolean().optional(),
+    /** When true, merge the final composed environment into `process.env`. */
     loadProcess: z.boolean().optional(),
+    /** When true, log the final environment map via `logger`. */
     log: z.boolean().optional(),
+    /** Logger used when `log` is enabled (console-compatible). */
     logger: z.unknown().default(console),
+    /** Optional output dotenv file path to write after composition. */
     outputPath: z.string().optional(),
+    /** Dotenv search paths (ordered). */
     paths: z.array(z.string()).optional(),
+    /** Private token suffix for private dotenv files (default `local`). */
     privateToken: z.string().optional(),
+    /** Explicit variables to overlay onto the composed dotenv map. */
     vars: processEnvSchema.optional(),
 });
 /**
@@ -47,6 +79,14 @@ const getDotenvOptionsSchemaRaw = z.object({
  * For now, this mirrors the RAW schema; future stages may materialize defaults
  * and narrow shapes as resolution is wired into the host.
  */
+/**
+ * Programmatic options schema (resolved).
+ *
+ * Today this mirrors {@link getDotenvOptionsSchemaRaw}, but is kept as a distinct export
+ * so future resolution steps can narrow or materialize defaults without breaking the API.
+ *
+ * @public
+ */
 const getDotenvOptionsSchemaResolved = getDotenvOptionsSchemaRaw;
 
 /**
@@ -56,27 +96,55 @@ const getDotenvOptionsSchemaResolved = getDotenvOptionsSchemaRaw;
  * reflect normalized types (paths: string[], vars: ProcessEnv), applied in the
  * CLI resolution pipeline.
  */
+/**
+ * CLI options schema (raw).
+ *
+ * Extends the programmatic options schema with CLI-only flags and stringly inputs
+ * which are normalized later by the host resolution pipeline.
+ *
+ * @public
+ */
 const getDotenvCliOptionsSchemaRaw = getDotenvOptionsSchemaRaw.extend({
     // CLI-specific fields (stringly inputs before preprocessing)
+    /** Enable verbose debug output (host-specific). */
     debug: z.boolean().optional(),
+    /** Fail on validation errors (schema/requiredKeys). */
     strict: z.boolean().optional(),
+    /** Capture child process stdio (useful for CI/tests). */
     capture: z.boolean().optional(),
+    /** Emit child env diagnostics (boolean or selected keys). */
     trace: z.union([z.boolean(), z.array(z.string())]).optional(),
+    /** Enable presentation-time redaction in trace/log output. */
     redact: z.boolean().optional(),
+    /** Enable entropy warnings in trace/log output. */
     warnEntropy: z.boolean().optional(),
+    /** Entropy threshold (bits/char) for warnings. */
     entropyThreshold: z.number().optional(),
+    /** Minimum value length to consider for entropy warnings. */
     entropyMinLength: z.number().optional(),
+    /** Regex patterns (strings) to suppress entropy warnings by key. */
     entropyWhitelist: z.array(z.string()).optional(),
+    /** Additional key-match patterns (strings) for redaction. */
     redactPatterns: z.array(z.string()).optional(),
+    /** Dotenv search paths provided as a single delimited string. */
     paths: z.string().optional(),
+    /** Delimiter string used to split `paths`. */
     pathsDelimiter: z.string().optional(),
+    /** Regex pattern used to split `paths` (takes precedence over delimiter). */
     pathsDelimiterPattern: z.string().optional(),
+    /** Scripts table in a permissive shape at parse time (validated elsewhere). */
     scripts: z.record(z.string(), z.unknown()).optional(),
+    /** Shell selection (`false` for shell-off, string for explicit shell). */
     shell: z.union([z.boolean(), z.string()]).optional(),
+    /** Extra variables expressed as a single delimited string of assignments. */
     vars: z.string().optional(),
+    /** Assignment operator used when parsing `vars`. */
     varsAssignor: z.string().optional(),
+    /** Regex pattern used as the assignment operator for `vars` parsing. */
     varsAssignorPattern: z.string().optional(),
+    /** Delimiter string used to split `vars`. */
     varsDelimiter: z.string().optional(),
+    /** Regex pattern used to split `vars` (takes precedence over delimiter). */
     varsDelimiterPattern: z.string().optional(),
 });
 
@@ -100,17 +168,34 @@ const envStringMap = z.record(z.string(), stringMap);
  * Raw configuration schema for get‑dotenv config files (JSON/YAML/JS/TS).
  * Validates allowed top‑level keys without performing path normalization.
  */
+/**
+ * Config schema for discovered get-dotenv configuration documents (raw).
+ *
+ * This schema validates the allowed top-level keys for configuration files.
+ * It does not normalize paths or coerce types beyond Zod’s parsing.
+ *
+ * @public
+ */
 const getDotenvConfigSchemaRaw = z.object({
+    /** Root option defaults applied by the host (CLI-like, collapsed families). */
     rootOptionDefaults: getDotenvCliOptionsSchemaRaw.optional(),
+    /** Help-time visibility map for root flags (false hides). */
     rootOptionVisibility: visibilityMap.optional(),
-    scripts: z.record(z.string(), z.unknown()).optional(), // Scripts validation left wide; generator validates elsewhere
+    /** Scripts table used by cmd/batch resolution (validation intentionally permissive here). */
+    scripts: z.record(z.string(), z.unknown()).optional(),
+    /** Keys required to be present in the final composed environment. */
     requiredKeys: z.array(z.string()).optional(),
+    /** Validation schema (JS/TS only; JSON/YAML loader rejects). */
     schema: z.unknown().optional(), // JS/TS-only; loader rejects in JSON/YAML
+    /** Public global variables (string-only). */
     vars: stringMap.optional(), // public, global
+    /** Public per-environment variables (string-only). */
     envVars: envStringMap.optional(), // public, per-env
     // Dynamic in config (JS/TS only). JSON/YAML loader will reject if set.
+    /** Dynamic variable definitions (JS/TS only). */
     dynamic: z.unknown().optional(),
     // Per-plugin config bag; validated by plugins/host when used.
+    /** Per-plugin config slices keyed by realized mount path (for example, `aws/whoami`). */
     plugins: z.record(z.string(), z.unknown()).optional(),
 });
 /**
@@ -940,13 +1025,21 @@ function traceChildEnv(opts) {
  * Base root CLI defaults (shared; kept untyped here to avoid cross-layer deps).
  * Used as the bottom layer for CLI option resolution.
  */
+const baseScripts = {
+    'git-status': {
+        cmd: 'git branch --show-current && git status -s -u',
+        shell: true,
+    },
+};
 /**
- * Default values for root CLI options used by the host and helpers as the
- * baseline layer during option resolution.
+ * Default values for root CLI options used by the host and helpers as the baseline layer during option resolution.
+ *
+ * These defaults correspond to the “stringly” root surface (see `RootOptionsShape`) and are merged by precedence with:
+ * - create-time overrides
+ * - any discovered configuration `rootOptionDefaults`
+ * - and finally CLI flags at runtime
  *
- * These defaults correspond to the "stringly" root surface (see `RootOptionsShape`)
- * and are merged by precedence with create-time overrides and any discovered
- * configuration `rootOptionDefaults` before CLI flags are applied.
+ * @public
  */
 const baseRootOptionDefaults = {
     dotenvToken: '.env',
@@ -960,12 +1053,7 @@ const baseRootOptionDefaults = {
     paths: './',
     pathsDelimiter: ' ',
     privateToken: 'local',
-    scripts: {
-        'git-status': {
-            cmd: 'git branch --show-current && git status -s -u',
-            shell: true,
-        },
-    },
+    scripts: baseScripts,
     shell: true,
     vars: '',
     varsAssignor: '=',
@@ -1512,6 +1600,14 @@ async function _execNormalized(command, shell, opts = {}) {
         return out;
     }
 }
+/**
+ * Execute a command and return its exit code.
+ *
+ * @param command - Command string (shell) or argv array (shell-off supported).
+ * @param shell - Shell setting (false for plain execution).
+ * @param opts - Execution options (cwd/env/stdio).
+ * @returns A promise resolving to the process exit code.
+ */
 async function runCommand(command, shell, opts) {
     // Build opts without injecting undefined (exactOptionalPropertyTypes-safe)
     const callOpts = {};
@@ -1971,6 +2067,16 @@ function evaluateDynamicOptions(root, resolved) {
     visit(root);
 }
 
+/**
+ * Initialize a {@link GetDotenvCli} instance with help configuration and safe defaults.
+ *
+ * @remarks
+ * This is a low-level initializer used by the host constructor to keep `GetDotenvCli.ts`
+ * small and to centralize help/output behavior.
+ *
+ * @param cli - The CLI instance to initialize.
+ * @param headerGetter - Callback returning an optional help header string.
+ */
 function initializeInstance(cli, headerGetter) {
     // Configure grouped help: show only base options in default "Options";
     // subcommands show all of their own options.
@@ -2940,6 +3046,7 @@ const attachCmdParentInvoker = (cli, options, plugin) => {
  */
 const cmdPluginConfigSchema = z
     .object({
+    /** When true, expand the alias value before execution (default behavior when omitted). */
     expand: z.boolean().optional(),
 })
     .strict();