Struct AuthMethodTerminal 

#[non_exhaustive]
pub struct AuthMethodTerminal {
    pub method_id: AuthMethodId,
    pub name: String,
    pub description: Option<String>,
    pub args: Vec<String>,
    pub env: Vec<EnvVariable>,
    pub meta: Option<Meta>,
}

Available on crate feature unstable_protocol_v2 only.

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 auth/login.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

method_id: AuthMethodId

Unique identifier for this authentication method.

name: String

Human-readable name of the authentication method.

description: Option<String>

Optional description providing more details about this authentication method.

args: Vec<String>

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

env: Vec<EnvVariable>

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

meta: Option<Meta>

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

Implementations

impl AuthMethodTerminal

pub fn new(method_id: impl Into<AuthMethodId>, name: impl Into<String>) -> Self

Builds AuthMethodTerminal with the required fields set; optional fields start unset or empty.

pub fn args(self, args: Vec<String>) -> Self

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

pub fn env(self, env: Vec<EnvVariable>) -> Self

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

pub fn description(self, description: impl IntoOption<String>) -> Self

Optional description providing more details about this authentication method.

pub fn meta(self, meta: impl IntoOption<Meta>) -> Self

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

Trait Implementations

impl Clone for AuthMethodTerminal

fn clone(&self) -> AuthMethodTerminal

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AuthMethodTerminal

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuthMethodTerminal

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for AuthMethodTerminal

impl JsonSchema for AuthMethodTerminal

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for AuthMethodTerminal

fn eq(&self, other: &AuthMethodTerminal) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for AuthMethodTerminal

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AuthMethodTerminal