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

    Type Alias AuthMethodTerminalExperimental

    UNSTABLE

    This capability is not part of the spec yet, and may be removed or changed at any point.

    Terminal-based authentication method.

    The client runs an interactive terminal for the user to authenticate via a TUI.

    type AuthMethodTerminal = {
        _meta?: { [key: string]: unknown } | null;
        args?: string[];
        description?: string | null;
        env?: { [key: string]: string };
        id: string;
        name: string;
    }
    Index

    Properties

    _meta? args? description? env? id name

    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[]

    Additional arguments to pass when running the agent binary for terminal auth.

    description?: string | null

    Optional description providing more details about this authentication method.

    env?: { [key: string]: string }

    Additional environment variables to set when running the agent binary for terminal auth.

    id: string

    Unique identifier for this authentication method.

    name: string

    Human-readable name of the authentication method.

    Settings

    Member Visibility

    On This Page

    Properties