Rulvar API reference / @rulvar/rulvar / ResearchFanOutOptions
Interface: ResearchFanOutOptions
Defined in: packages/core/dist/index.d.ts
Options of researchFanOut: the research template's plus the money and the roster.
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
budgetUsd | number | The declared money per child, in USD: the profile's estCost, the extension's headroom floor (a tenth of it), and the figure the acceptance's limit profile measures spend against. | - | packages/core/dist/index.d.ts |
children? | number | Children the acceptance requires spawned; absent leaves the roster floor off. | - | packages/core/dist/index.d.ts |
description? | string | Advertised profile description; the template provides a default. | ResearchAgentProfileOptions.description | packages/core/dist/index.d.ts |
evidenceContract? | EvidenceContract | The declared evidence floor of the task (RV303), passed through to AgentProfile.evidenceContract so preflight can compare it against the profile's tool budget and warn tool-cap-below-evidence-floor before any paid call. | ResearchAgentProfileOptions.evidenceContract | packages/core/dist/index.d.ts |
extraTools? | ToolDef<SchemaSpec<unknown>>[] | Extra tools appended after the research toolset. | ResearchAgentProfileOptions.extraTools | packages/core/dist/index.d.ts |
ignore? | string[] | Extra ignored basenames (files and directories), merged over the always-on defaults '.git' and 'node_modules'. | ResearchAgentProfileOptions.ignore | packages/core/dist/index.d.ts |
includeHidden? | boolean | Walk dot-entries too; default false. | ResearchAgentProfileOptions.includeHidden | packages/core/dist/index.d.ts |
limits? | UsageLimits | Per-key overrides over RESEARCH_PROFILE_LIMITS. | ResearchAgentProfileOptions.limits | packages/core/dist/index.d.ts |
maxFileBytes? | number | Files larger than this many bytes are refused; default 262144. | ResearchAgentProfileOptions.maxFileBytes | packages/core/dist/index.d.ts |
maxScannedFiles? | number | Walk ceiling per call (files visited); default 20000. | ResearchAgentProfileOptions.maxScannedFiles | packages/core/dist/index.d.ts |
minTerminalOutputChars? | number | The character floor a limit child's terminal output must clear to be salvaged. | - | packages/core/dist/index.d.ts |
pageSize? | number | Rows per list/search/evidence page; default 50. | ResearchAgentProfileOptions.pageSize | packages/core/dist/index.d.ts |
readPageChars? | number | Content budget of one read_file page in characters; default 4000. | ResearchAgentProfileOptions.readPageChars | packages/core/dist/index.d.ts |
root | string | The confining directory root; everything resolves under it. | ResearchAgentProfileOptions.root | packages/core/dist/index.d.ts |
summaryMaxOutputTokens? | number | The finalization reserve summary allowance; default 8000. | - | packages/core/dist/index.d.ts |