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

    Interface GetDotenvCliPlugin

    Public plugin contract used by the GetDotenv CLI host.

    interface GetDotenvCliPlugin {
        afterResolve?: (
            cli: GetDotenvCliPublic,
            ctx: GetDotenvCliCtx,
        ) => void | Promise<void>;
        children: GetDotenvCliPlugin[];
        configSchema?: ZodType<
            unknown,
            unknown,
            $ZodTypeInternals<unknown, unknown>,
        >;
        id?: string;
        setup: (cli: GetDotenvCliPublic) => void | Promise<void>;
        use: (child: GetDotenvCliPlugin) => GetDotenvCliPlugin;
    }
    Index

    Properties

    afterResolve? children configSchema? id? setup use

    Properties

    afterResolve?: (
        cli: GetDotenvCliPublic,
        ctx: GetDotenvCliCtx,
    ) => 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).

    children: GetDotenvCliPlugin[]

    Compositional children. Installed after the parent per pre-order.

    configSchema?: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>

    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.

    id?: string
    setup: (cli: GetDotenvCliPublic) => void | Promise<void>

    Setup phase: register commands and wiring on the provided CLI instance. Runs parent → children (pre-order).

    use: (child: GetDotenvCliPlugin) => GetDotenvCliPlugin

    Compose a child plugin. Returns the parent to enable chaining.

    Settings

    Member Visibility

    On This Page

    Properties