ACP v2 TypeScript SDK — EXPERIMENTAL DRAFT - v1.3.0
    Preparing search index...

    Type Alias TerminalUpdateExperimental

    An upsert for the stored state of an agent-owned terminal.

    Only [TerminalUpdate::terminal_id] is required. Other fields have patch semantics: omitted fields leave the stored value unchanged, null clears it, and concrete values replace it. When the terminal ID is new, omitted fields start unknown.

    type TerminalUpdate = {
        terminalId: TerminalId;
        command?: string | null;
        cwd?: AbsolutePath | null;
        output?: TerminalOutput | null;
        exitStatus?: TerminalExitStatus | null;
        _meta?: { [key: string]: unknown } | null;
    }
    Index
    terminalId command? cwd? output? exitStatus? _meta?
    terminalId: TerminalId

    Unique identifier for this terminal within the session.

    command?: string | null

    The command being run.

    cwd?: AbsolutePath | null

    The absolute working directory of the command.

    output?: TerminalOutput | null

    An authoritative replacement snapshot of terminal output bytes.

    exitStatus?: TerminalExitStatus | null

    Exit information. A concrete object marks the terminal as exited.

    Optional_meta

    _meta?: { [key: string]: unknown } | null

    The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Omitted means no metadata update; null is an explicit clear signal. Implementations MUST NOT make assumptions about values at these keys.

    See protocol docs: Extensibility

    Settings
    Member Visibility

    On This Page
    Properties