Rulvar API reference

---

Rulvar API reference / @rulvar/plan / orchestratePlanned

Function: orchestratePlanned()

function orchestratePlanned(
   engine, 
   goal, 
   opts?, 
runOptions?): RunHandle<unknown>;

Defined in: packages/plan/src/plan-runner.ts:2981

The PlanRunner entry surface: mode (c) plus the extension in one call. runOptions are the ordinary engine RunOptions of the created run: runOptions.budgetUsd is the ROOT hard ceiling over the whole tree, immutable within a segment, while opts.budget only shapes the orchestrator's own sub-account inside it (v1.18.0 review P1-5).

Parameters

Parameter	Type
engine	Engine
goal	string
opts?	OrchestrateOptions & { plan?: PlanRunnerOptions; }
runOptions?	RunOptions

Returns

RunHandle<unknown>