Skip to content

rulvar API reference


rulvar API reference / @rulvar/cli / runCli

Function: runCli()

ts
function runCli(argv, options): Promise<number>;

Defined in: packages/cli/src/cli-main.ts:41

@rulvar/cli: the rulvar shell (https://docs.rulvar.com/guide/cli). M5 surface: run/resume/runs ls/inspect over the canonical grammar, TUI progress on the event stream, interactive resolution of suspended approvals and externals. plan/kb commands land M6+/M10; createServer/createWorker land M8; the OTel exporter lands M5-T08.

The CLI builds exclusively from the public @rulvar/core API; adapters and defaults come from the host's rulvar.config.mjs (or the workflow module's exports), never from CLI dependencies.

Parameters

ParameterType
argvstring[]
options{ cwd: string; io: CliIo; }
options.cwdstring
options.ioCliIo

Returns

Promise&lt;number&gt;