SandboxLease

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

Parameters and properties

fileTransfersOptional
FileTransfers | undefined
Manifest and batch capabilities for remote synchronization: Outpost downloads only changed files and verifies their SHA-256. Without it, files move one by one through upload() and download(); Vercel and Daytona provide it.
liveInputOptional
boolean | undefined
True when invoke() streams Command.input to the running process. CLI steering reaches a running turn only on such a lease, otherwise Outpost stops and resumes the agent; built-in harness MCP servers require it. Every built-in provider sets it.
rootRequired
string
Repository directory inside the sandbox; commands run there when Command.directory is unset.
homeRequired
string
Agent home inside the sandbox, where Outpost installs credentials, CLI settings and native conversations. The local provider uses your host home.
invokeRequired
(command: Command) => Promise<CommandResult>
Runs a command in the sandbox and resolves when the process exits, with its real status, even nonzero, and the retained stdout and stderr. signal and deadlineMs stop the process and its descendants without closing the sandbox.
uploadRequired
(source: string, destination: string, options?: TransferOptions) => Promise<void>
Transfer host files or directory contents into the sandbox, honoring transfer cancellation and deadline.
downloadRequired
(source: string, destination: string, options?: TransferOptions) => Promise<void>
Transfer sandbox files or directory contents to the host, preserving supported permissions and links.
releaseRequired
() => Promise<void>
Destroys the environment and stops its running commands. Outpost calls it when the sandbox closes; a second call must resolve without error.

Signature

export interface SandboxLease {
  readonly fileTransfers?: FileTransfers;
  /** Whether invoke accepts Command.input as live stdin for a running process. */
  readonly liveInput?: boolean;
  readonly root: string;
  readonly home: string;
  invoke(command: Command): Promise<CommandResult>;
  upload(
    source: string,
    destination: string,
    options?: TransferOptions,
  ): Promise<void>;
  download(
    source: string,
    destination: string,
    options?: TransferOptions,
  ): Promise<void>;
  release(): Promise<void>;
}

Parameters and properties

Signature

Related contracts