Skip to content
v9.1.1
Français

SandboxDiagnosticOptions

import type { SandboxDiagnosticOptions } from "@elie-laloum/outpost";

Parameters and properties

Section titled “Parameters and properties”
  • agentOptional
    BuiltInAgentName | undefined
    Built-in agent whose CLI is checked in the sandbox: its version (agent.sandbox), then its help for each mode Outpost uses (agent.cli.<mode>). Without it, no agent check runs.
  • deadlineMsOptional
    number | undefined
    Deadline of each probe command and transfer in milliseconds, default 5000. Must be an integer from 1 to 60000, otherwise the call rejects with code configuration.
  • signalOptional
    AbortSignal | undefined
    Cancels the diagnosis. Already aborted, the call rejects with the abort reason; aborted during the run, the remaining probes are reported as fail.
  • transfersOptional
    boolean | undefined
    true uploads a small binary file under the sandbox root, verifies it with a sandbox process, downloads it back, then removes the probe directory (checks sandbox.transfers and sandbox.transfers.cleanup). Off by default.
  • sandboxProviderOptional
    Pick<SandboxProvider, "name" | "placement"> | undefined
    Provider name and placement copied into the report. sandbox.diagnose() replaces it with the sandbox’s own provider.

Signature

Section titled “Signature”
export interface SandboxDiagnosticOptions {
  readonly agent?: DoctorAgent;
  readonly deadlineMs?: number;
  readonly signal?: AbortSignal;
  readonly transfers?: boolean;
  readonly sandboxProvider?: Pick<SandboxProvider, "name" | "placement">;
}
Section titled “Related contracts”