Sandbox

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

Paramètres et propriétés

diagnoseRequis
(options?: SandboxDiagnosticOptions) => Promise<SandboxDiagnosticReport>
Sonde node, git et l’exécution de commandes dans cette sandbox, ainsi qu’un CLI d’agent et les transferts de fichiers sur demande. Se résout avec un rapport dont hasFailures signale les vérifications échouées ; n’installe jamais l’agent.
workspaceRequis
Workspace
Workspace dans lequel travaille cette sandbox. close() ne le ferme aussi que si createSandbox() l’a ouvert ; fermez un workspace fourni après la sandbox.
rootRequis
string
Chemin du dépôt dans la sandbox ; les commandes sans directory s’y exécutent.
dispatchRequis
<T = undefined>(options: DispatchOptions<T>) => Promise<WarmDispatchResult<T>>
Exécute un brief dans une nouvelle conversation sur cette sandbox et se résout avec un résultat chaud dont resume() et fork() restent ici. La branche n’est pas intégrée et la sandbox reste ouverte, y compris en cas d’échec, où le recovery de l’erreur indique la branche et le répertoire.
resumeRequis
<T = undefined>(id: string, options: DispatchOptions<T>) => Promise<WarmDispatchResult<T>>
Poursuit la conversation native de cet identifiant sur cette sandbox, en la restaurant d’abord si elle a été capturée ailleurs. L’agent doit savoir reprendre une conversation.
forkRequis
<T = undefined>(id: string, options: DispatchOptions<T>) => Promise<WarmDispatchResult<T>>
Poursuit une copie de la conversation native de cet identifiant sur cette sandbox, sans modifier l’originale. L’agent doit prendre en charge le fork automatisé.
attachRequis
(options?: AttachOptions) => Promise<AttachResult>
Lance le CLI de l’agent dans votre terminal, à l’intérieur de cette sandbox, avec un brief ou une continuation facultatifs, et se résout à votre sortie avec son statut et ses commits. Exige un agent CLI unique ; la session est arrêtée après 86400000 (24 heures).
commandRequis
(command: Command) => Promise<CommandResult>
Exécute un programme dans cette sandbox et se résout avec son statut et sa sortie, même pour un statut non nul ; rejette à l’échéance de son délai, à l’annulation de son signal ou à la fermeture de la sandbox. Sur un provider distant, les modifications de la sandbox sont ensuite rapatriées dans le worktree de l’hôte.
closeRequis
(options?: { readonly preserve?: boolean; }) => Promise<Disposal>
Interrompt l’opération en cours, libère l’environnement et, si createSandbox() a ouvert le workspace, le ferme ; se résout avec retainedDirectory quand le worktree est conservé. preserve: true conserve le worktree ; les appels suivants renvoient la promesse du premier.
[Symbol.asyncDispose]Requis
() => Promise<void>
Appelle close() sans options, pour que await using ferme la sandbox à la fin de son bloc.

Signature

export interface Sandbox {
  diagnose(
    options?: SandboxDiagnosticOptions,
  ): Promise<SandboxDiagnosticReport>;
  readonly workspace: Workspace;
  readonly root: string;
  dispatch<T = undefined>(
    options: DispatchOptions<T>,
  ): Promise<WarmDispatchResult<T>>;
  resume<T = undefined>(
    id: string,
    options: DispatchOptions<T>,
  ): Promise<WarmDispatchResult<T>>;
  fork<T = undefined>(
    id: string,
    options: DispatchOptions<T>,
  ): Promise<WarmDispatchResult<T>>;
  attach(options?: AttachOptions): Promise<AttachResult>;
  command(command: Command): Promise<CommandResult>;
  close(options?: { readonly preserve?: boolean }): Promise<Disposal>;
  [Symbol.asyncDispose](): Promise<void>;
}

Paramètres et propriétés

Signature

Contrats associés