Skip to content
v9.1.1
Français

WorkspaceRecord

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

Parameters and properties

Section titled “Parameters and properties”
  • repositoryRequired
    string
    Real path of the host checkout’s top-level directory.
  • directoryRequired
    string
    Host directory the agent works in: the worktree under .outpost/workspaces, or the checkout itself in current mode.
  • branchRequired
    string
    Work branch name. In current mode, the checked-out branch, or HEAD when detached.
  • baseBranchRequired
    string
    Branch checked out in the host checkout when the workspace opened, and the target of integrate(). Empty when HEAD was detached.
  • baselineRequired
    string
    Commit checked out in the workspace when it opened. Each dispatch lists commits from its own starting commit, not from this one.
  • gitDirectoriesRequired
    readonly string[]
    Host paths of the worktree’s Git directory and the repository’s common Git directory. Container providers mount them unless repositoryMode is isolated.
  • policyRequired
    BranchPolicy
    Branch policy in effect, { mode: “current” } when none was given.

Signature

Section titled “Signature”
export interface WorkspaceRecord {
  readonly repository: string;
  readonly directory: string;
  readonly branch: string;
  readonly baseBranch: string;
  readonly baseline: string;
  readonly gitDirectories: readonly string[];
  readonly policy: BranchPolicy;
}
Section titled “Related contracts”