rulvar API reference / @rulvar/core / OrchestrateOptions
Interface: OrchestrateOptions
Defined in: packages/core/src/orchestrator/orchestrate.ts:79
Options for orchestrate(engine, goal, o?).
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
budget? | OrchestratorBudgetSpec | The orchestrator's own budget sub-account (cap enforcement layers only in M6). | packages/core/src/orchestrator/orchestrate.ts:86 |
extension? | OrchestratorExtension | The opt-in mode (c) extension seam (M7-T05): PlanRunner from @rulvar/plan attaches here. The extension boots strictly before the orchestrator's first agent entry, contributes tools, schedules ready plan nodes on every settlement, and participates in the mandatory quiescence trigger. | packages/core/src/orchestrator/orchestrate.ts:103 |
limits? | UsageLimits | UsageLimits of the orchestrator agent itself (maxTurns etc.). | packages/core/src/orchestrator/orchestrate.ts:95 |
maxSpawns? | number | Per-orchestrate spawn cap; the engine lifetime cap applies regardless. | packages/core/src/orchestrator/orchestrate.ts:84 |
model? | ModelSpec | - | packages/core/src/orchestrator/orchestrate.ts:80 |
profiles? | string[] | Registered profile names to advertise; default: every profile. | packages/core/src/orchestrator/orchestrate.ts:82 |
renderBudgetChars? | number | Deterministic digest render bound: each TaskDigest outputSummary is clamped to this many CHARACTERS (the model-independent measure; OQ-04 closed at M10 entry). Default WAKE_SUMMARY_RENDER_BUDGET_CHARS. | packages/core/src/orchestrator/orchestrate.ts:93 |