Configuration
Full rover('boot', config) reference.
Workspace snippet generation includes required fields and only non-default overrides you set, so output stays minimal and accurate.
Core Auth & Identity
| Option | Type | Description |
|---|---|---|
siteIdreq | string | Workspace site identifier for this embed deployment. |
apiKeyreq | string | Rover key generated in Workspace. Required for cloud-backed runtime calls. |
siteKeyId | string | Optional key ID returned by Workspace. Included in generated snippets. |
apiBase | string | Optional API base override for custom proxying or self-managed backend routes. Use the base URL directly (no `/extensionRouter` suffix needed). |
authToken | string | Optional bearer token override used for extensionRouter authorization. |
auth.enableSessionJwt | boolean | Enable runtime session JWT flow for backend calls. |
auth.sessionJwtEndpoint | string | Endpoint returning short-lived session JWTs for Rover requests. |
auth.refreshSkewSec | number | Refresh window in seconds before session JWT expiry. |
visitorId | string | Stable visitor identifier. Auto-generated when omitted unless checkpointing auto visitor is disabled. |
sessionId | string | Explicit session identifier. Useful when you need hard control over restore boundaries. |
sessionScope | 'shared_site' | 'tab' | Cross-tab shared session (`shared_site`) or strict tab isolation (`tab`). |
workerUrl | string | Custom worker bundle URL, primarily for self-hosting and strict CSP setups. |
mode | 'full' | 'safe' | Top-level runtime mode. `safe` is constrained execution mode. |
Domain Guardrails & Navigation
| Option | Type | Description |
|---|---|---|
allowedDomainsreq | string[] | Allowed hostnames for Rover runtime. Supports wildcard entries like `*.example.com`. |
domainScopeMode | 'registrable_domain' | 'host_only' | Domain matching behavior for allowed host checks. |
externalNavigationPolicy | 'open_new_tab_notice' | 'block' | 'allow' | Out-of-scope navigation policy for external domains. |
openOnInit | boolean | Open the Rover panel immediately after boot. |
allowActions | boolean | Allow/deny action tools (click/fill/navigate). Set false for read-only assistance. |
tabPolicy.observerByDefault | boolean | Observer behavior preference for multi-tab coordination. |
tabPolicy.actionLeaseMs | number | Control lease duration used by shared session coordinator. |
Task Routing
| Option | Type | Description |
|---|---|---|
taskRouting.mode | 'auto' | 'act' | 'planner' | Route tasks directly to ACT, always planner, or automatic routing. |
taskRouting.actHeuristicThreshold | number | Complexity threshold for auto routing escalation to planner. |
taskRouting.plannerOnActError | boolean | When ACT fails in auto mode, retry through planner. |
Task Context
| Option | Type | Description |
|---|---|---|
taskContext.resetMode | 'auto' | 'ask' | 'off' | Advisory task reset policy; hard resets still follow completion/new-task boundaries. |
taskContext.inactivityMs | number | Optional inactivity hint used by task continuity logic. |
taskContext.suggestReset | boolean | Allow Rover to surface reset suggestions when continuity is unclear. |
taskContext.semanticSimilarityThreshold | number (0..1) | Optional similarity hint for continuity scoring. |
Checkpointing
| Option | Type | Description |
|---|---|---|
checkpointing.enabled | boolean | Persist worker/session state via checkpoint service. |
checkpointing.autoVisitorId | boolean | Auto-generate visitor ID when checkpointing is enabled. |
checkpointing.flushIntervalMs | number | Push interval for checkpoint writes. |
checkpointing.pullIntervalMs | number | Pull interval for checkpoint refresh. |
checkpointing.minFlushIntervalMs | number | Minimum debounce interval for checkpoint writes. |
checkpointing.ttlHours | number | Checkpoint document TTL in hours. |
API Execution
| Option | Type | Description |
|---|---|---|
apiMode | boolean | Force cloud API mode on/off instead of automatic behavior. |
apiToolsConfig.mode | 'allowlist' | 'profile' | 'none' | Controls additional tool exposure in API mode. |
apiToolsConfig.enableAdditionalTools | string[] | Additional first-party tool names to enable. |
apiToolsConfig.userDefined | string[] | User-defined tool identifiers available to the runtime. |
Telemetry
| Option | Type | Description |
|---|---|---|
telemetry.enabled | boolean | Enable Rover runtime telemetry batching to cloud backend. |
telemetry.sampleRate | number (0..1) | Sampling ratio for telemetry events. |
telemetry.flushIntervalMs | number | Periodic flush interval for telemetry batches. |
telemetry.maxBatchSize | number | Maximum event count per telemetry batch request. |
telemetry.includePayloads | boolean | Include richer payload data in telemetry (higher storage cost). |
External Web Context & Client Tools
| Option | Type | Description |
|---|---|---|
tools.web.enableExternalWebContext | boolean | Allow best-effort cloud context fetch for inaccessible external tabs. |
tools.web.scrapeMode | 'off' | 'on_demand' | On-demand scrape of active external tab context when needed. |
tools.web.allowDomains | string[] | Optional allowlist for external context fetch hostnames. |
tools.web.denyDomains | string[] | Optional denylist for external context fetch hostnames. |
tools.client | ClientToolDefinition[] | Runtime-registered client tools. Usually configured in application code, not in script snippets. |
UI & Branding
| Option | Type | Description |
|---|---|---|
ui.agent.name | string | Assistant display name and runtime context name passed to the model. |
ui.mascot.disabled | boolean | Disable mascot video in launcher/header. |
ui.mascot.mp4Url | string | Custom mascot MP4 URL. |
ui.mascot.webmUrl | string | Custom mascot WebM URL. |
ui.muted | boolean | Start Rover UI in muted media mode. |
ui.thoughtStyle | 'concise_cards' | 'minimal' | UI thought rendering style preference. |
ui.panel.resizable | boolean | UI panel resizing preference. |
ui.showTaskControls | boolean | Show/hide task lifecycle controls in the UI. |