Rulvar API reference / @rulvar/planner / PlanOptions
Interface: PlanOptions
Defined in: packages/planner/src/plan.ts:40
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
model? | ModelSpec | The planner model; otherwise the chain resolves role 'plan'. | packages/planner/src/plan.ts:42 |
profiles? | string[] | Registered profile names to advertise; default: every profile. | packages/planner/src/plan.ts:44 |
repairRounds? | number | Self-repair rounds from JSON diagnostics; default 3 (Appendix A). A nonnegative integer (zero means a single draft, no repair), refused as a ConfigError before the runId derivation, store lookup, and any provider dispatch. | packages/planner/src/plan.ts:51 |
run? | Pick<RunOptions, "budgetUsd" | "limits" | "deadlineAt" | "signal"> | Run options of the planning conversation itself, applied at GENESIS only: the first plan() of a goal starts the journal with them, and budgetUsd becomes the run's immutable ceiling B0, recorded in RunMeta. A later plan() of the same goal resumes the existing journal under its RECORDED ceiling: a differing explicit budgetUsd warns (RULVAR_PLAN_BUDGET_DRIFT) and never tops up or replaces the frozen value, and limits/deadlineAt/signal do not apply to a resumed journal (core resume semantics; cancel through the handle). The runId stays goal-derived (planRunIdOf) and is not overridable. Absent options, the planning run is UNBOUNDED, as before. | packages/planner/src/plan.ts:64 |