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

    Type Alias AuthMethodTerminal

    Terminal-based authentication method.

    The client runs the configured agent program as a separate interactive process for the user to authenticate via a TUI. Agents MUST advertise this method only when the client enabled its terminal authentication capability. A zero exit status signals success; any other termination signals failure. The client MUST NOT pass this method to authenticate.

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

    Unique identifier for this authentication method.

    name: string

    Human-readable name of the authentication method.

    description?: string | null

    Optional description providing more details about this authentication method.

    args?: string[]

    Additional arguments to append to the configured agent invocation for terminal auth.

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

    Additional environment variables to set on the configured agent invocation for terminal auth. These values override same-named variables in the base launch configuration.

    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