rskim 2.3.1

The most intelligent context optimization engine for coding agents. Code-aware AST parsing, command rewriting, output compression.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

//! `skim agents` -- display detected AI agents and their hook/session status.
//!
//! Scans for known AI coding agents (Claude Code, Cursor, Codex CLI, Gemini CLI,
//! Copilot CLI) and reports their detection status, session paths, hook installation
//! status, and rules directory presence.

mod detection;
mod formatting;
mod types;
mod util;

use std::process::ExitCode;

use detection::detect_all_agents;
use formatting::{print_help, print_json, print_text};

/// Run the `skim agents` subcommand.
pub(crate) fn run(args: &[String]) -> anyhow::Result<ExitCode> {
    if args.iter().any(|a| matches!(a.as_str(), "--help" | "-h")) {
        print_help();
        return Ok(ExitCode::SUCCESS);
    }

    let json_output = args.iter().any(|a| a == "--json");

    let agents = detect_all_agents();

    if json_output {
        print_json(&agents)?;
    } else {
        print_text(&agents);
    }

    Ok(ExitCode::SUCCESS)
}

/// Build the clap `Command` definition for shell completions.
pub(super) fn command() -> clap::Command {
    clap::Command::new("agents")
        .about("Display detected AI agents and their integration status")
        .arg(
            clap::Arg::new("json")
                .long("json")
                .action(clap::ArgAction::SetTrue)
                .help("Output as JSON"),
        )
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::cmd::session::AgentKind;
    use types::HookStatus;

    #[test]
    fn test_agents_run_no_crash() {
        let result = run(&[]);
        assert!(result.is_ok());
    }

    #[test]
    fn test_agents_help_flag() {
        let result = run(&["--help".to_string()]);
        assert!(result.is_ok());
    }

    #[test]
    fn test_agents_json_output_valid_json() {
        let agents = detect_all_agents();
        assert_eq!(
            agents.len(),
            AgentKind::all_supported().len(),
            "agent count should match supported kinds"
        );

        let result = run(&["--json".to_string()]);
        assert!(result.is_ok());

        for agent in &agents {
            match &agent.hooks {
                HookStatus::Installed { integrity, .. } => {
                    assert!(
                        ["ok", "tampered", "missing", "unknown"].contains(integrity),
                        "unexpected integrity value: {integrity}"
                    );
                }
                HookStatus::NotInstalled => {}
                HookStatus::NotSupported { note } => {
                    assert!(!note.is_empty(), "NotSupported note should not be empty");
                }
            }
        }
    }

    #[test]
    fn test_hook_status_display() {
        let installed = HookStatus::Installed {
            version: Some("2.0.0".to_string()),
            integrity: "ok",
        };
        match &installed {
            HookStatus::Installed { version, integrity } => {
                assert_eq!(version.as_deref(), Some("2.0.0"));
                assert_eq!(*integrity, "ok");
            }
            _ => panic!("expected Installed"),
        }

        let not_supported = HookStatus::NotSupported {
            note: "experimental",
        };
        match &not_supported {
            HookStatus::NotSupported { note } => {
                assert_eq!(*note, "experimental");
            }
            _ => panic!("expected NotSupported"),
        }
    }

    #[test]
    fn test_agent_kind_cli_name() {
        assert_eq!(AgentKind::ClaudeCode.cli_name(), "claude-code");
        assert_eq!(AgentKind::Cursor.cli_name(), "cursor");
        assert_eq!(AgentKind::CodexCli.cli_name(), "codex");
        assert_eq!(AgentKind::GeminiCli.cli_name(), "gemini");
        assert_eq!(AgentKind::CopilotCli.cli_name(), "copilot");
        assert_eq!(AgentKind::OpenCode.cli_name(), "opencode");
    }

    #[test]
    fn test_agent_kind_all_supported() {
        let all = AgentKind::all_supported();
        assert!(all.len() >= 5, "expected at least 5 agents");
        assert!(all.contains(&AgentKind::ClaudeCode));
        assert!(all.contains(&AgentKind::Cursor));
        assert!(all.contains(&AgentKind::CodexCli));
        assert!(all.contains(&AgentKind::GeminiCli));
        assert!(all.contains(&AgentKind::CopilotCli));
    }
}