Member Junction
    Preparing search index...

    Interface IMJCLIRuntimeHost

    The runtime host abstracts all stdio. A plugin talks to the host through this interface; the host decides whether a call becomes a spinner line, a JSON event on stderr, or nothing — based on the active OutputFormat.

    interface IMJCLIRuntimeHost {
        Format: OutputFormat;
        Interactive: boolean;
        Verbose: boolean;
        AnnounceRuntime(usage: PluginUsage): void;
        Emit(result: MJCLIResult): void;
        FailStep(label: string, detail?: string): void;
        Log(message: string, level?: LogLevel): void;
        StartStep(label: string): void;
        SucceedStep(label: string, detail?: string): void;
        UpdateStep(label: string): void;
    }

    Implemented by

    Index

    Properties

    Format Interactive Verbose

    Methods

    AnnounceRuntime Emit FailStep Log StartStep SucceedStep UpdateStep

    Properties

    Format: OutputFormat

    The active output format. Plugins gate human-only text rendering on this.

    Interactive: boolean

    Whether this run may prompt — true at a real terminal, false when piped, spawned, or running in CI, unless --interactive / --no-interactive overrides it. Plugins read this to choose between asking and failing fast with the flag to pass.

    Verbose: boolean

    Whether --verbose was set.

    Methods

    • Runtime advisory, emitted before work starts so an agent can budget its timeout (plan §5/§6). Text mode: a dim one-liner on stderr. JSON mode: a {event:'start', ...} line on stderr. Suppressed for fast commands.

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods