Member Junction
    Preparing search index...

    Interface PluginUsage

    Per-plugin usage + runtime metadata. Drives the progressive-disclosure mj usage (tier 1) and mj <domain> usage (tier 2) surface and the timeout advisory (plan §5). Co-located with the plugin so it can never drift from the actual flags.

    interface PluginUsage {
        command: string;
        description?: string;
        domain: string;
        examples?: string[];
        flags?: PluginUsageFlag[];
        runtime: RuntimeHint;
        summary: string;
    }
    Index

    Properties

    command description? domain examples? flags? runtime summary

    Properties

    command: string

    The invocation key — e.g. 'sync:push', 'codegen', 'migrate'.

    description?: string

    Fuller prose, shown only in mj <domain> usage.

    domain: string

    Groups commands in mj usage — e.g. 'sync', 'codegen', 'migrate'.

    examples?: string[]

    Copy-pasteable invocations.

    flags?: PluginUsageFlag[]
    runtime: RuntimeHint
    summary: string

    One line, shown in the mj usage domain map. Keep it terse.

    Settings

    Member Visibility

    On This Page

    Properties