Skip to content

Rulvar API reference


Rulvar API reference / @rulvar/cli / reportOutcome

Function: reportOutcome()

ts
function reportOutcome(outcome, io): number;

Defined in: packages/cli/src/drive.ts:194

Renders the settled outcome; returns the process exit code. Error messages, suspension keys, model refs, and phase names originate from providers, tools, and workflow authors, so each is sanitized before it reaches a terminal line, matching the TUI renderer (v1.24.1 review P2-1). Values print as JSON, which escapes control bytes on its own.

Parameters

ParameterType
outcomeRunOutcome<unknown>
ioCliIo

Returns

number