Class MJCLIRuntimeHost

Default implementation of IMJCLIRuntimeHost.

Text mode (default): an ora spinner with a live elapsed timer for steps, chalk-colored logs, and a generic human summary on MJCLIRuntimeHost.Emit when the plugin hasn't already rendered its own. Plugins that want rich, command-specific text (e.g. a push summary box) build the string themselves and pass it through MJCLIRuntimeHost.Log — the host never hard-codes per-command formatting.
JSON mode: every decorative call (steps, logs, runtime advisory) goes to stderr so the MJCLIResult JSON on stdout stays clean and pipeable (plan D4: mj sync push --format=json | jq .errors).
MD mode: the result is emitted as a fenced ```json block on stdout (forward-looking slot for AI chat UIs, plan D10).

Implements

IMJCLIRuntimeHost

Index

Constructors

Properties

Methods

AnnounceRuntime Emit FailStep Log StartStep SucceedStep UpdateStep

Constructors

constructor

new MJCLIRuntimeHost(
    format?: OutputFormat,
    verbose?: boolean,
    noBanner?: boolean,
): MJCLIRuntimeHost
Parameters
- format: OutputFormat = 'text'
- verbose: boolean = false
- noBanner: boolean = false
Returns MJCLIRuntimeHost
- Defined in src/runtime-host.ts:34

Properties

`Readonly`Format

Format: OutputFormat

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

`Readonly`Verbose

Verbose: boolean

Whether --verbose was set.

Methods

AnnounceRuntime

AnnounceRuntime(usage: PluginUsage): void
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
- usage: PluginUsage
Returns void
Implementation of IMJCLIRuntimeHost.AnnounceRuntime
- Defined in src/runtime-host.ts:147

Emit

Emit(result: MJCLIResult): void
Final result — host serializes per the active --format.
Parameters
- result: MJCLIResult
Returns void
Implementation of IMJCLIRuntimeHost.Emit
- Defined in src/runtime-host.ts:162

FailStep

FailStep(label: string, detail?: string): void
Parameters
- label: string
- Optionaldetail: string
Returns void
Implementation of IMJCLIRuntimeHost.FailStep
- Defined in src/runtime-host.ts:120

Log

Log(message: string, level?: LogLevel): void
Parameters
- message: string
- level: LogLevel = 'info'
Returns void
Implementation of IMJCLIRuntimeHost.Log
- Defined in src/runtime-host.ts:134

StartStep

StartStep(label: string): void
Parameters
- label: string
Returns void
Implementation of IMJCLIRuntimeHost.StartStep
- Defined in src/runtime-host.ts:84

SucceedStep

SucceedStep(label: string, detail?: string): void
Parameters
- label: string
- Optionaldetail: string
Returns void
Implementation of IMJCLIRuntimeHost.SucceedStep
- Defined in src/runtime-host.ts:105

UpdateStep

UpdateStep(label: string): void
Parameters
- label: string
Returns void
Implementation of IMJCLIRuntimeHost.UpdateStep
- Defined in src/runtime-host.ts:95