Agent Client Protocol - v1.2.1
    Preparing search index...

    Type Alias CreateTerminalRequest

    Request to create a new terminal and execute a command.

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

    The session ID for this request.

    command: string

    The command to execute.

    args?: string[]

    Array of command arguments.

    env?: EnvVariable[]

    Environment variables for the command.

    cwd?: string | null

    Working directory for the command. Must be an absolute path.

    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.

    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

    Settings
    Member Visibility

    On This Page
    Properties