@karmaniverous/get-dotenv 5.2.6 → 6.0.0-1

package/dist/cliHost.d.ts

@@ -1,5 +1,6 @@
-import { Command } from 'commander';
-import { ZodType } from 'zod';
+import { Command, Option } from 'commander';
+import { z, ZodObject } from 'zod';
+export { z } from 'zod';
 
 /**
  * Minimal root options shape shared by CLI and generator layers.
@@ -47,12 +48,34 @@ type RootOptionsShape = {
  */
 type ScriptsTable<TShell extends string | boolean = string | boolean> = Record<string, string | {
     cmd: string;
-    shell?: TShell;
+    shell?: TShell | undefined;
 }>;
 
+declare const getDotenvOptionsSchemaResolved: z.ZodObject<{
+    defaultEnv: z.ZodOptional<z.ZodString>;
+    dotenvToken: z.ZodOptional<z.ZodString>;
+    dynamicPath: z.ZodOptional<z.ZodString>;
+    dynamic: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    env: z.ZodOptional<z.ZodString>;
+    excludeDynamic: z.ZodOptional<z.ZodBoolean>;
+    excludeEnv: z.ZodOptional<z.ZodBoolean>;
+    excludeGlobal: z.ZodOptional<z.ZodBoolean>;
+    excludePrivate: z.ZodOptional<z.ZodBoolean>;
+    excludePublic: z.ZodOptional<z.ZodBoolean>;
+    loadProcess: z.ZodOptional<z.ZodBoolean>;
+    log: z.ZodOptional<z.ZodBoolean>;
+    logger: z.ZodOptional<z.ZodUnknown>;
+    outputPath: z.ZodOptional<z.ZodString>;
+    paths: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    privateToken: z.ZodOptional<z.ZodString>;
+    vars: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodString>>>;
+}, z.core.$strip>;
+
 /**
  * A minimal representation of an environment key/value mapping.
- * Values may be `undefined` to represent "unset". */ type ProcessEnv = Record<string, string | undefined>;
+ * Values may be `undefined` to represent "unset".
+ */
+type ProcessEnv = Record<string, string | undefined>;
 /**
  * Dynamic variable function signature. Receives the current expanded variables
  * and the selected environment (if any), and returns either a string to set
@@ -62,173 +85,203 @@ type GetDotenvDynamicFunction = (vars: ProcessEnv, env: string | undefined) => s
 type GetDotenvDynamic = Record<string, GetDotenvDynamicFunction | ReturnType<GetDotenvDynamicFunction>>;
 type Logger = Record<string, (...args: unknown[]) => void> | typeof console;
 /**
- * Options passed programmatically to `getDotenv`.
+ * Canonical programmatic options type (schema-derived).
+ * This type is the single source of truth for programmatic options.
  */
-interface GetDotenvOptions {
-    /**
-     * default target environment (used if `env` is not provided)
-     */
-    defaultEnv?: string;
-    /**
-     * token indicating a dotenv file
-     */
-    dotenvToken: string;
+type GetDotenvOptions = z.output<typeof getDotenvOptionsSchemaResolved> & {
     /**
-     * path to JS/TS module default-exporting an object keyed to dynamic variable functions
+     * Compile-time overlay: narrowed logger for DX (schema stores unknown).
      */
-    dynamicPath?: string;
+    logger?: Logger;
     /**
-     * Programmatic dynamic variables map. When provided, this takes precedence
-     * over {@link GetDotenvOptions.dynamicPath}.
+     * Compile-time overlay: narrowed dynamic map for DX (schema stores unknown).
      */
     dynamic?: GetDotenvDynamic;
+};
+
+declare const getDotenvCliOptionsSchemaResolved: z.ZodObject<{
+    defaultEnv: z.ZodOptional<z.ZodString>;
+    dotenvToken: z.ZodOptional<z.ZodString>;
+    dynamicPath: z.ZodOptional<z.ZodString>;
+    dynamic: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    env: z.ZodOptional<z.ZodString>;
+    excludeDynamic: z.ZodOptional<z.ZodBoolean>;
+    excludeEnv: z.ZodOptional<z.ZodBoolean>;
+    excludeGlobal: z.ZodOptional<z.ZodBoolean>;
+    excludePrivate: z.ZodOptional<z.ZodBoolean>;
+    excludePublic: z.ZodOptional<z.ZodBoolean>;
+    loadProcess: z.ZodOptional<z.ZodBoolean>;
+    log: z.ZodOptional<z.ZodBoolean>;
+    logger: z.ZodOptional<z.ZodUnknown>;
+    outputPath: z.ZodOptional<z.ZodString>;
+    privateToken: z.ZodOptional<z.ZodString>;
+    debug: z.ZodOptional<z.ZodBoolean>;
+    strict: z.ZodOptional<z.ZodBoolean>;
+    capture: z.ZodOptional<z.ZodBoolean>;
+    trace: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodArray<z.ZodString>]>>;
+    redact: z.ZodOptional<z.ZodBoolean>;
+    warnEntropy: z.ZodOptional<z.ZodBoolean>;
+    entropyThreshold: z.ZodOptional<z.ZodNumber>;
+    entropyMinLength: z.ZodOptional<z.ZodNumber>;
+    entropyWhitelist: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    redactPatterns: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    paths: z.ZodOptional<z.ZodString>;
+    pathsDelimiter: z.ZodOptional<z.ZodString>;
+    pathsDelimiterPattern: z.ZodOptional<z.ZodString>;
+    scripts: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    shell: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>;
+    vars: z.ZodOptional<z.ZodString>;
+    varsAssignor: z.ZodOptional<z.ZodString>;
+    varsAssignorPattern: z.ZodOptional<z.ZodString>;
+    varsDelimiter: z.ZodOptional<z.ZodString>;
+    varsDelimiterPattern: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+
+type Scripts = ScriptsTable;
+/**
+ * Canonical CLI options type derived from the Zod schema output.
+ * Includes CLI-only flags (debug/strict/capture/trace/redaction/entropy),
+ * stringly paths/vars, and inherited programmatic fields (minus normalized
+ * shapes that are handled by resolution).
+ */
+type GetDotenvCliOptions = z.output<typeof getDotenvCliOptionsSchemaResolved> & {
     /**
-     * target environment
-     */
-    env?: string;
-    /**
-     * exclude dynamic variables from loading
-     */
-    excludeDynamic?: boolean;
-    /**
-     * exclude environment-specific variables from loading
-     */
-    excludeEnv?: boolean;
-    /**
-     * exclude global variables from loading
-     */
-    excludeGlobal?: boolean;
-    /**
-     * exclude private variables from loading
-     */
-    excludePrivate?: boolean;
-    /**
-     * exclude public variables from loading
-     */
-    excludePublic?: boolean;
-    /**
-     * load dotenv variables to `process.env`
-     */
-    loadProcess?: boolean;
-    /**
-     * log loaded dotenv variables to `logger`
-     */
-    log?: boolean;
-    /**
-     * logger object (defaults to console)
+     * Compile-only overlay for DX: logger narrowed from unknown.
      */
     logger?: Logger;
     /**
-     * if populated, writes consolidated dotenv file to this path (follows dotenvExpand rules)
+     * Compile-only overlay for DX: scripts narrowed from Record\<string, unknown\>.
      */
-    outputPath?: string;
-    /**
-     * array of input directory paths
-     */
-    paths?: string[];
-    /**
-     * filename token indicating private variables
-     */
-    privateToken?: string;
-    /**
-     * explicit variables to include
-     */
-    vars?: ProcessEnv;
-    /**
-     * 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.
-     */
-    useConfigLoader?: boolean;
-}
+    scripts?: Scripts;
+};
 
-type Scripts = Record<string, string | {
-    cmd: string;
-    shell?: string | boolean;
-}>;
+type ResolvedHelpConfig = Partial<GetDotenvCliOptions> & {
+    plugins: Record<string, unknown>;
+};
+/** Per-invocation context shared with plugins and actions. */
+type GetDotenvCliCtx<TOptions extends GetDotenvOptions = GetDotenvOptions> = {
+    optionsResolved: TOptions;
+    dotenv: ProcessEnv;
+    plugins?: Record<string, unknown>;
+    pluginConfigs?: Record<string, unknown>;
+};
+declare const CTX_SYMBOL: unique symbol;
+declare const OPTS_SYMBOL: unique symbol;
+declare const HELP_HEADER_SYMBOL: unique symbol;
 /**
- * Options passed programmatically to `getDotenvCli`.
+ * Plugin-first CLI host for get-dotenv. Extends Commander.Command.
+ *
+ * Responsibilities:
+ * - Resolve options strictly and compute dotenv context (resolveAndLoad).
+ * - Expose a stable accessor for the current context (getCtx).
+ * - Provide a namespacing helper (ns).
+ * - Support composable plugins with parent → children install and afterResolve.
  */
-interface GetDotenvCliOptions extends Omit<GetDotenvOptions, 'paths' | 'vars'> {
-    /**
-     * Logs CLI internals when true.
-     */
-    debug?: boolean;
+declare class GetDotenvCli$1<TOptions extends GetDotenvOptions = GetDotenvOptions> extends Command implements GetDotenvCliPublic<TOptions> {
+    /** Registered top-level plugins (composition happens via .use()) */
+    private _plugins;
+    /** One-time installation guard */
+    private _installed;
+    /** Optional header line to prepend in help output */
+    private [HELP_HEADER_SYMBOL];
+    /** Context/options stored under symbols (typed) */
+    private [CTX_SYMBOL]?;
+    private [OPTS_SYMBOL]?;
     /**
-     * Strict mode: fail the run when env validation issues are detected
-     * (schema or requiredKeys). Warns by default when false or unset.
+     * Create a subcommand using the same subclass, preserving helpers like
+     * dynamicOption on children.
      */
-    strict?: boolean;
+    createCommand(name?: string): Command;
+    constructor(alias?: string);
     /**
-     * Redaction (presentation): mask secret-like values in logs/trace.
+     * Resolve options (strict) and compute dotenv context.
+     * Stores the context on the instance under a symbol.
+     *
+     * Options:
+     * - opts.runAfterResolve (default true): when false, skips running plugin
+     *   afterResolve hooks. Useful for top-level help rendering to avoid
+     *   long-running side-effects while still evaluating dynamic help text.
      */
-    redact?: boolean;
+    resolveAndLoad(customOptions?: Partial<TOptions>, opts?: {
+        runAfterResolve?: boolean;
+    }): Promise<GetDotenvCliCtx<TOptions>>;
     /**
-     * Entropy warnings (presentation): emit once-per-key warnings for high-entropy values.
+     * Create a Commander Option that computes its description at help time.
+     * The returned Option may be configured (conflicts, default, parser) and
+     * added via addOption().
      */
-    warnEntropy?: boolean;
-    entropyThreshold?: number;
-    entropyMinLength?: number;
-    entropyWhitelist?: string[];
-    redactPatterns?: string[];
+    createDynamicOption(flags: string, desc: (cfg: ResolvedHelpConfig & {
+        plugins: Record<string, unknown>;
+    }) => string, parser?: (value: string, previous?: unknown) => unknown, defaultValue?: unknown): Option;
+    createDynamicOption<TValue = unknown>(flags: string, desc: (cfg: ResolvedHelpConfig & {
+        plugins: Record<string, unknown>;
+    }) => string, parser: (value: string, previous?: TValue) => TValue, defaultValue?: TValue): Option;
     /**
-     * When true, capture child stdout/stderr and re-emit after completion.
-     * Useful for tests/CI. Default behavior is streaming via stdio: 'inherit'.
+     * Chainable helper mirroring .option(), but with a dynamic description.
+     * Equivalent to addOption(createDynamicOption(...)).
      */
-    capture?: boolean;
+    dynamicOption(flags: string, desc: (cfg: ResolvedHelpConfig & {
+        plugins: Record<string, unknown>;
+    }) => string, parser?: (value: string, previous?: unknown) => unknown, defaultValue?: unknown): this;
     /**
-     * A delimited string of paths to dotenv files.
+     * Evaluate dynamic descriptions for this command and all descendants using
+     * the provided resolved configuration. Mutates the Option.description in
+     * place so Commander help renders updated text.
      */
-    paths?: string;
+    evaluateDynamicOptions(resolved: ResolvedHelpConfig): void;
     /**
-     * A delimiter string with which to split `paths`. Only used if
-     * `pathsDelimiterPattern` is not provided.
+     * Retrieve the current invocation context (if any).
      */
-    pathsDelimiter?: string;
+    getCtx(): GetDotenvCliCtx<TOptions> | undefined;
     /**
-     * A regular expression pattern with which to split `paths`. Supersedes
-     * `pathsDelimiter`.
+     * Retrieve the merged root CLI options bag (if set by passOptions()).
+     * Downstream-safe: no generics required.
      */
-    pathsDelimiterPattern?: string;
+    getOptions(): GetDotenvCliOptions | undefined;
+    /** Internal: set the merged root options bag for this run. */
+    _setOptionsBag(bag: GetDotenvCliOptions): void;
+    /** Convenience helper to create a namespaced subcommand. */
+    ns(name: string): Command;
     /**
-     * Scripts that can be executed from the CLI, either individually or via the batch subcommand.
+     * Tag options added during the provided callback as 'app' for grouped help.
+     * Allows downstream apps to demarcate their root-level options.
      */
-    scripts?: Scripts;
+    tagAppOptions<T>(fn: (root: Command) => T): T;
     /**
-     * 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`)
+     * Branding helper: set CLI name/description/version and optional help header.
+     * If version is omitted and importMetaUrl is provided, attempts to read the
+     * nearest package.json version (best-effort; non-fatal on failure).
      */
-    shell?: string | boolean;
+    brand(args: {
+        name?: string;
+        description?: string;
+        version?: string;
+        importMetaUrl?: string;
+        helpHeader?: string;
+    }): Promise<this>;
     /**
-     * A delimited string of key-value pairs declaratively specifying variables &
-     * values to be loaded in addition to any dotenv files.
+     * Insert grouped plugin/app options between "Options" and "Commands" for
+     * hybrid ordering. Applies to root and any parent command.
      */
-    vars?: string;
+    helpInformation(): string;
     /**
-     * A string with which to split keys from values in `vars`. Only used if
-     * `varsDelimiterPattern` is not provided.
+     * Public: tag an Option with a display group for help (root/app/plugin:<id>).
      */
-    varsAssignor?: string;
+    setOptionGroup(opt: Option, group: string): void;
     /**
-     * A regular expression pattern with which to split variable names from values
-     * in `vars`. Supersedes `varsAssignor`.
+     * Register a plugin for installation (parent level).
+     * Installation occurs on first resolveAndLoad() (or explicit install()).
      */
-    varsAssignorPattern?: string;
+    use(plugin: GetDotenvCliPlugin<TOptions>): this;
     /**
-     * A string with which to split `vars` into key-value pairs. Only used if
-     * `varsDelimiterPattern` is not provided.
+     * Install all registered plugins in parent → children (pre-order).
+     * Runs only once per CLI instance.
      */
-    varsDelimiter?: string;
+    install(): Promise<void>;
     /**
-     * A regular expression pattern with which to split `vars` into key-value
-     * pairs. Supersedes `varsDelimiter`.
+     * Run afterResolve hooks for all plugins (parent → children).
      */
-    varsDelimiterPattern?: string;
+    private _runAfterResolve;
 }
 
 /** src/cliHost/definePlugin.ts
@@ -247,134 +300,89 @@ interface GetDotenvCliOptions extends Omit<GetDotenvOptions, 'paths' | 'vars'> {
  * Purpose: remove nominal class identity (private fields) from the plugin seam
  * to avoid TS2379 under exactOptionalPropertyTypes in downstream consumers.
  */
-type GetDotenvCliPublic<TOptions extends GetDotenvOptions = GetDotenvOptions> = Command & {
-    ns: (name: string) => Command;
-    getCtx: () => GetDotenvCliCtx<TOptions> | undefined;
-    resolveAndLoad: (customOptions?: Partial<TOptions>) => Promise<GetDotenvCliCtx<TOptions>>;
-};
+interface GetDotenvCliPublic<TOptions extends GetDotenvOptions = GetDotenvOptions> extends Command {
+    ns(name: string): Command;
+    getCtx(): GetDotenvCliCtx<TOptions> | undefined;
+    resolveAndLoad(customOptions?: Partial<TOptions>, opts?: {
+        runAfterResolve?: boolean;
+    }): Promise<GetDotenvCliCtx<TOptions>>;
+    setOptionGroup(opt: Option, group: string): void;
+    /**
+     * Create a dynamic option whose description is computed at help time
+     * from the resolved configuration.
+     */
+    createDynamicOption(flags: string, desc: (cfg: ResolvedHelpConfig & {
+        plugins: Record<string, unknown>;
+    }) => string, parser?: (value: string, previous?: unknown) => unknown, defaultValue?: unknown): Option;
+    createDynamicOption<TValue = unknown>(flags: string, desc: (cfg: ResolvedHelpConfig & {
+        plugins: Record<string, unknown>;
+    }) => string, parser: (value: string, previous?: TValue) => TValue, defaultValue?: TValue): Option;
+}
 /** Public plugin contract used by the GetDotenv CLI host. */
-interface GetDotenvCliPlugin {
+interface GetDotenvCliPlugin<TOptions extends GetDotenvOptions = GetDotenvOptions> {
     id?: string;
     /**
      * Setup phase: register commands and wiring on the provided CLI instance.
      * Runs parent → children (pre-order).
      */
-    setup: (cli: GetDotenvCliPublic) => void | Promise<void>;
+    setup: (cli: GetDotenvCliPublic<TOptions>) => void | Promise<void>;
     /**
      * After the dotenv context is resolved, initialize any clients/secrets
      * or attach per-plugin state under ctx.plugins (by convention).
      * Runs parent → children (pre-order).
      */
-    afterResolve?: (cli: GetDotenvCliPublic, ctx: GetDotenvCliCtx) => void | Promise<void>;
+    afterResolve?: (cli: GetDotenvCliPublic<TOptions>, ctx: GetDotenvCliCtx<TOptions>) => void | Promise<void>;
     /**
-     * Optional Zod schema for this plugin's config slice (from config.plugins[id]).
-     * When provided, the host validates the merged config under the guarded loader path.
+     * Zod schema for this plugin's config slice (from config.plugins[id]).
+     * Enforced object-like (ZodObject) to simplify code paths and inference.
      */
-    configSchema?: ZodType;
+    configSchema?: ZodObject;
     /**
      * Compositional children. Installed after the parent per pre-order.
      */
-    children: GetDotenvCliPlugin[];
+    children: GetDotenvCliPlugin<TOptions>[];
     /**
      * Compose a child plugin. Returns the parent to enable chaining.
      */
-    use: (child: GetDotenvCliPlugin) => GetDotenvCliPlugin;
+    use: (child: GetDotenvCliPlugin<TOptions>) => GetDotenvCliPlugin<TOptions>;
 }
+/**
+ * Compile-time helper type: the plugin object returned by definePlugin always
+ * includes the instance-bound helpers as required members. Keeping the public
+ * interface optional preserves compatibility for ad-hoc/test plugins, while
+ * return types from definePlugin provide stronger DX for shipped/typed plugins.
+ */
+type PluginWithInstanceHelpers<TOptions extends GetDotenvOptions = GetDotenvOptions, TConfig = unknown> = GetDotenvCliPlugin<TOptions> & {
+    readConfig<TCfg = TConfig>(cli: GetDotenvCliPublic<TOptions>): Readonly<TCfg>;
+    createPluginDynamicOption<TCfg = TConfig>(cli: GetDotenvCliPublic<TOptions>, flags: string, desc: (cfg: ResolvedHelpConfig & {
+        plugins: Record<string, unknown>;
+    }, pluginCfg: Readonly<TCfg>) => string, parser?: (value: string, previous?: unknown) => unknown, defaultValue?: unknown): Option;
+};
 /**
  * Public spec type for defining a plugin with optional children.
  * Exported to ensure TypeDoc links and navigation resolve correctly.
  */
-type DefineSpec = Omit<GetDotenvCliPlugin, 'children' | 'use'> & {
-    children?: GetDotenvCliPlugin[];
+type DefineSpec<TOptions extends GetDotenvOptions = GetDotenvOptions> = Omit<GetDotenvCliPlugin<TOptions>, 'children' | 'use'> & {
+    children?: GetDotenvCliPlugin<TOptions>[];
 };
 /**
  * Define a GetDotenv CLI plugin with compositional helpers.
  *
  * @example
- * const parent = definePlugin(\{ id: 'p', setup(cli) \{ /* ... *\/ \} \})
+ * const parent = definePlugin({ id: 'p', setup(cli) { /* omitted *\/ } })
  *   .use(childA)
  *   .use(childB);
  */
-declare const definePlugin: (spec: DefineSpec) => GetDotenvCliPlugin;
+declare function definePlugin<TOptions extends GetDotenvOptions, Schema extends ZodObject>(spec: Omit<DefineSpec<TOptions>, 'configSchema'> & {
+    configSchema: Schema;
+}): PluginWithInstanceHelpers<TOptions, z.output<Schema>>;
+declare function definePlugin<TOptions extends GetDotenvOptions>(spec: DefineSpec<TOptions>): PluginWithInstanceHelpers<TOptions, {}>;
 
-/** * Per-invocation context shared with plugins and actions. */
-type GetDotenvCliCtx<TOptions extends GetDotenvOptions = GetDotenvOptions> = {
-    optionsResolved: TOptions;
-    dotenv: ProcessEnv;
-    plugins?: Record<string, unknown>;
-    pluginConfigs?: Record<string, unknown>;
-};
-declare const HELP_HEADER_SYMBOL: unique symbol;
 /**
- * Plugin-first CLI host for get-dotenv. Extends Commander.Command.
- *
- * Responsibilities:
- * - Resolve options strictly and compute dotenv context (resolveAndLoad).
- * - Expose a stable accessor for the current context (getCtx).
- * - Provide a namespacing helper (ns).
- * - Support composable plugins with parent → children install and afterResolve.
- *
- * NOTE: This host is additive and does not alter the legacy CLI.
+ * Infer the compile-time plugin config type from a plugin instance created by definePlugin.
+ * Returns a deeply readonly view to discourage mutation at call sites.
  */
-declare class GetDotenvCli$1<TOptions extends GetDotenvOptions = GetDotenvOptions> extends Command {
-    #private;
-    /** Registered top-level plugins (composition happens via .use()) */
-    private _plugins;
-    /** One-time installation guard */
-    private _installed;
-    /** Optional header line to prepend in help output */
-    private [HELP_HEADER_SYMBOL];
-    constructor(alias?: string);
-    /**
-     * Resolve options (strict) and compute dotenv context.   * Stores the context on the instance under a symbol.
-     */
-    resolveAndLoad(customOptions?: Partial<TOptions>): Promise<GetDotenvCliCtx<TOptions>>;
-    /**
-     * Retrieve the current invocation context (if any).
-     */
-    getCtx(): GetDotenvCliCtx<TOptions> | undefined;
-    /**
-     * Retrieve the merged root CLI options bag (if set by passOptions()).
-     * Downstream-safe: no generics required.
-     */
-    getOptions(): GetDotenvCliOptions | undefined;
-    /** Internal: set the merged root options bag for this run. */
-    _setOptionsBag(bag: GetDotenvCliOptions): void;
-    /**   * Convenience helper to create a namespaced subcommand.
-     */
-    ns(name: string): Command;
-    /**
-     * Tag options added during the provided callback as 'app' for grouped help.
-     * Allows downstream apps to demarcate their root-level options.
-     */
-    tagAppOptions<T>(fn: (root: Command) => T): T;
-    /**
-     * Branding helper: set CLI name/description/version and optional help header.
-     * If version is omitted and importMetaUrl is provided, attempts to read the
-     * nearest package.json version (best-effort; non-fatal on failure).
-     */
-    brand(args: {
-        name?: string;
-        description?: string;
-        version?: string;
-        importMetaUrl?: string;
-        helpHeader?: string;
-    }): Promise<this>;
-    /**
-     * Register a plugin for installation (parent level).
-     * Installation occurs on first resolveAndLoad() (or explicit install()).
-     */
-    use(plugin: GetDotenvCliPlugin): this;
-    /**
-     * Install all registered plugins in parent → children (pre-order).
-     * Runs only once per CLI instance.
-     */
-    install(): Promise<void>;
-    /**
-     * Run afterResolve hooks for all plugins (parent → children).
-     */
-    private _runAfterResolve;
-}
+type InferPluginConfig<P> = P extends PluginWithInstanceHelpers<GetDotenvOptions, infer C> ? Readonly<C> : never;
 
 /**
  * GetDotenvCli with root helpers as real class methods.
@@ -387,9 +395,7 @@ declare class GetDotenvCli extends GetDotenvCli$1 {
      * Attach legacy root flags to this CLI instance. Defaults come from
      * baseRootOptionDefaults when none are provided.
      */
-    attachRootOptions(defaults?: Partial<RootOptionsShape>, opts?: {
-        includeCommandOption?: boolean;
-    }): this;
+    attachRootOptions(defaults?: Partial<RootOptionsShape>): this;
     /**
      * Install preSubcommand/preAction hooks that:
      * - Merge options (parent round-trip + current invocation) using resolveCliOptions.
@@ -406,4 +412,4 @@ declare class GetDotenvCli extends GetDotenvCli$1 {
 declare const readMergedOptions: (cmd: Command) => GetDotenvCliOptions | undefined;
 
 export { GetDotenvCli, definePlugin, readMergedOptions };
-export type { DefineSpec, GetDotenvCliCtx, GetDotenvCliOptions, GetDotenvCliPlugin, GetDotenvCliPublic, ScriptsTable };
+export type { DefineSpec, GetDotenvCliCtx, GetDotenvCliOptions, GetDotenvCliPlugin, GetDotenvCliPublic, InferPluginConfig, PluginWithInstanceHelpers, ScriptsTable };