Volume

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

Parameters and properties

sourceRequired
string
Host path to mount; ~ expands to your home and a relative path resolves from the repository. A missing path fails acquisition with code provider.
targetRequired
string
Path inside the container: absolute, relative to the workspace root, or under the agent home with ~/. A single file must be mounted inside the agent home.
readOnlyOptional
boolean | undefined
Mount the volume without write access from the sandbox.

Signature

export interface Volume {
  readonly source: string;
  readonly target: string;
  readonly readOnly?: boolean;
}