Struct DetectedAgent

Source

pub struct DetectedAgent {
    pub id: &'static str,
    pub name: &'static str,
    pub kind: AgentKind,
}

Expand description

Information about a detected AI coding agent environment.

Fields§

§id: &'static str

A stable, unique identifier for the agent (e.g. "claude-code", "codex").

§name: &'static str

The human-readable name of the agent (e.g. "Claude Code", "OpenAI Codex").

§kind: AgentKind

The kind of AI coding environment.

Implementations§

Source §

impl DetectedAgent

Source

pub fn is_agent(&self) -> bool

Returns true if the detected environment is an autonomous agent.

Examples found in repository ?

examples/detect.rs (line 28)

8fn main() {
9    let agent = detect_coding_agent::detect();
10
11    match &agent {
12        Some(agent) => {
13            println!("✅ Coding agent detected!");
14            println!("   Name : {}", agent.name);
15            println!("   ID   : {}", agent.id);
16            println!("   Kind : {}", agent.kind);
17        }
18        None => {
19            println!("❌ No coding agent detected.");
20            println!(
21                "   The process does not appear to be running inside a known AI coding agent."
22            );
23        }
24    }
25
26    // Convenience helpers
27    if agent
28        .map(|a| a.is_agent() || a.is_hybrid())
29        .unwrap_or(false)
30    {
31        println!();
32        println!("💡 Tip: This is an autonomous agent session — consider offering a");
33        println!("   machine-friendly interface (e.g. via MCP) for better results.");
34    }
35}

Source

pub fn is_interactive(&self) -> bool

Returns true if the detected environment is interactive (human-driven).

Source

pub fn is_hybrid(&self) -> bool

Returns true if the detected environment is hybrid (agent + interactive).

Examples found in repository ?

examples/detect.rs (line 28)

8fn main() {
9    let agent = detect_coding_agent::detect();
10
11    match &agent {
12        Some(agent) => {
13            println!("✅ Coding agent detected!");
14            println!("   Name : {}", agent.name);
15            println!("   ID   : {}", agent.id);
16            println!("   Kind : {}", agent.kind);
17        }
18        None => {
19            println!("❌ No coding agent detected.");
20            println!(
21                "   The process does not appear to be running inside a known AI coding agent."
22            );
23        }
24    }
25
26    // Convenience helpers
27    if agent
28        .map(|a| a.is_agent() || a.is_hybrid())
29        .unwrap_or(false)
30    {
31        println!();
32        println!("💡 Tip: This is an autonomous agent session — consider offering a");
33        println!("   machine-friendly interface (e.g. via MCP) for better results.");
34    }
35}