Agent Client Protocol - v0.12.0
    Preparing search index...

    Type Alias CreateTerminalRequest

    Request to create a new terminal and execute a command.

    type CreateTerminalRequest = {
        _meta?: { [key: string]: unknown } | null;
        args?: string[];
        command: string;
        cwd?: string | null;
        env?: EnvVariable[];
        outputByteLimit?: number | null;
        sessionId: SessionId;
    }
    Index

    Properties

    _meta? args? command cwd? env? outputByteLimit? sessionId

    Properties

    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. Implementations MUST NOT make assumptions about values at these keys.

    See protocol docs: Extensibility

    args?: string[]

    Array of command arguments.

    command: string

    The command to execute.

    cwd?: string | null

    Working directory for the command (absolute path).

    env?: EnvVariable[]

    Environment variables for the command.

    outputByteLimit?: number | null

    Maximum number of output bytes to retain.

    When the limit is exceeded, the Client truncates from the beginning of the output to stay within the limit.

    The Client MUST ensure truncation happens at a character boundary to maintain valid string output, even if this means the retained output is slightly less than the specified limit.

    sessionId: SessionId

    The session ID for this request.

    Settings

    Member Visibility

    On This Page

    Properties