Skip to content
v9.1.1
Français

createReplayAgent

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

Purpose and behavior

Section titled “Purpose and behavior”

Create a single-use agent that replays one dispatch journal without calling a model. Each turn compares the rendered prompt, re-emits the recorded events and usage, and the last turn of each sandbox dispatch rebuilds the recorded commits with their original identities. A divergence throws ReplayDivergence (a warning for some kinds with divergence: “warn”); a malformed journal throws code configuration, and a replay agent cannot be steered.

Complete example and detailed rules.

Parameters and properties

Section titled “Parameters and properties”
  • optionsRequired
    ReplayAgentOptions
    Journal to replay and divergence policy.
  • options.journalRequired
    readonly unknown[]
    Entries returned by readJournal for one dispatch. Record with logging.replayable to include workspace commits.
  • options.divergenceOptional
    ReplayDivergencePolicy | undefined
    Divergence policy, default fail. warn continues after prompt, baseline, tree and unrecorded divergences, but still throws when a patch cannot be applied or the journal is exhausted.

Returns

Section titled “Returns”

ReplayAgent

Signature

Section titled “Signature”
export declare function createReplayAgent(
  options: ReplayAgentOptions,
): ReplayAgent;
Section titled “Related contracts”