Interface: CreateSandboxOptions
Defined in: src/batteries/sandbox/manager.ts:92
Options for createSandbox.
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
allowUnsandboxedFallback? | readonly | boolean | Permit degraded operation when the environment cannot provide OS containment. Remarks Fires only for pre-execution conditions resolved once at construction — a platform the backend cannot sandbox that we still run on, dependency errors, or an absent optional peer. It NEVER fires for a violation (a violation means the sandbox worked), and native Windows is refused outright rather than degraded. When it fires the handle is permanently marked and every invocation emits a loud observability event. Execution STILL goes through enforcer.run; this option never runs a command unsandboxed, and the tool descriptions tell the model it has no OS containment. | src/batteries/sandbox/manager.ts:126 |
enforcer | readonly | SandboxPolicyEnforcer | The boundary itself. Node's SRT-backed enforcer lives on the sandbox/node subpath. | src/batteries/sandbox/manager.ts:104 |
fsNodeVersion? | readonly | string | Recorded on observability events so a rules-versus-backend mismatch is diagnosable without a bisect. | src/batteries/sandbox/manager.ts:132 |
onSandbox? | readonly | (event: SandboxEvent) => void | Observability firehose: bypasses, fallbacks, drift outcomes, and the SRT version rules came from. | src/batteries/sandbox/manager.ts:114 |
optionalPeerPresent? | readonly | boolean | Whether the optional peer resolved; feeds the preflight decision above. | src/batteries/sandbox/manager.ts:130 |
policy | readonly | SandboxPolicy | ADK-owned policy vocabulary, mapped to the backend's config inside the enforcer. Remarks The per-axis defaults DIFFER and are not a symmetry worth "fixing": reads default to ALLOW (absent denyRead means everything is readable, and allowRead re-permits WITHIN a deny), while writes default to DENY and network is an allow-list. A checker that unified them would disagree with the OS by construction. | src/batteries/sandbox/manager.ts:102 |
probeSpawn? | readonly | boolean | Opt in to a real child-spawn liveness check during construction. | src/batteries/sandbox/manager.ts:134 |
strictMode? | readonly | boolean | Ignore the per-call escape entirely, matching the reference consumer's strict mode. | src/batteries/sandbox/manager.ts:128 |
translator? | readonly | PathTranslator | Model-path translation, and the redaction used on every observability event. Remarks Supply it if you want host identifiers scrubbed from the event stream — no battery-generated surface should carry the sandbox root, home directory, or user name. | src/batteries/sandbox/manager.ts:112 |