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

    Interface GroupPluginsOptions<TOptions>

    Options for groupPlugins.

    This helper creates a “namespace-only” parent plugin (a command that exists only to group child plugins under a shared prefix, like tooling getdotenv init).

    The returned plugin is composable: call .use(childPlugin) to mount children.

    interface GroupPluginsOptions<
        TOptions extends GetDotenvOptions = GetDotenvOptions,
    > {
        aliases?: string[];
        configure?: (cli: GetDotenvCliPublic<TOptions>) => void | Promise<void>;
        description?: string;
        helpGroup?: string;
        ns: string;
        summary?: string;
    }

    Type Parameters

    Index

    Properties

    aliases? configure? description? helpGroup? ns summary?

    Properties

    aliases?: string[]

    Optional aliases for the group command (e.g., ['gd']).

    configure?: (cli: GetDotenvCliPublic<TOptions>) => void | Promise<void>

    Optional hook to customize the group command mount (e.g., attach a note or a small set of options). Avoid adding actions here; keep this a group.

    description?: string

    Long-form description shown when rendering help for the group command.

    helpGroup?: string

    Help group heading for this command when listed in the parent’s help output.

    ns: string

    Namespace for the grouping command (the command name used in the CLI).

    summary?: string

    Short summary shown in the parent command’s subcommand list.

    Settings

    Member Visibility

    On This Page

    Properties