use std::io::Write;
use std::path::Path;
use crate::errors::{AgenticSshError, Result};
use super::{
AgentIntegration, DoctorCounters, HealthcheckContext, InstallContext, load_toml_file,
tool_names, write_toml_file,
};
pub struct CodexIntegration;
impl AgentIntegration for CodexIntegration {
fn name(&self) -> &'static str {
"Codex CLI"
}
fn id(&self) -> &'static str {
"codex"
}
fn install(&self, ctx: &InstallContext) -> Result<()> {
let codex_dir = ctx.home.join(".codex");
std::fs::create_dir_all(&codex_dir).ok();
let config_path = codex_dir.join("config.toml");
install_mcp_server(&config_path, &ctx.agentic_ssh_bin)?;
let agents_md = codex_dir.join("AGENTS.md");
install_prompt_rules(&agents_md)?;
eprintln!();
eprintln!("Setup complete. Next steps:");
eprintln!(" 1. Start a new Codex session — agentic_ssh tools are now available");
Ok(())
}
fn uninstall(&self, ctx: &InstallContext) -> Result<()> {
let codex_dir = ctx.home.join(".codex");
let config_path = codex_dir.join("config.toml");
uninstall_mcp_server(&config_path)?;
let agents_md = codex_dir.join("AGENTS.md");
uninstall_prompt_rules(&agents_md);
eprintln!();
eprintln!("Uninstall complete. AgenticSsh has been removed from Codex CLI.");
eprintln!("Start a new Codex session for changes to take effect.");
Ok(())
}
fn healthcheck(&self, dc: &mut DoctorCounters, ctx: &HealthcheckContext) {
eprintln!("\n\x1b[1mCodex CLI integration\x1b[0m");
let codex_dir = ctx.home.join(".codex");
let config_path = codex_dir.join("config.toml");
doctor_check_config(dc, &config_path);
doctor_check_prompt(dc, &codex_dir);
}
fn is_detected(&self, home: &Path) -> bool {
home.join(".codex").is_dir()
}
fn primary_config_path(&self, home: &Path) -> Option<std::path::PathBuf> {
Some(home.join(".codex/config.toml"))
}
fn has_agentic_ssh(&self, home: &Path) -> bool {
let config = home.join(".codex").join("config.toml");
if !config.exists() {
return false;
}
super::load_toml_file(&config).is_ok_and(|toml| {
toml.get("mcp_servers")
.and_then(|v| v.get("agentic_ssh"))
.is_some()
})
}
}
fn install_mcp_server(config_path: &Path, agentic_ssh_bin: &str) -> Result<()> {
let mut config = load_toml_file(config_path)?;
let table = config
.as_table_mut()
.ok_or_else(|| AgenticSshError::Config {
message: "config.toml is not a TOML table".to_string(),
})?;
let servers = table
.entry("mcp_servers")
.or_insert_with(|| toml::Value::Table(toml::map::Map::new()))
.as_table_mut()
.ok_or_else(|| AgenticSshError::Config {
message: "mcp_servers is not a table in config.toml".to_string(),
})?;
let mut server_table = toml::map::Map::new();
server_table.insert(
"command".to_string(),
toml::Value::String(agentic_ssh_bin.to_string()),
);
server_table.insert(
"args".to_string(),
toml::Value::Array(vec![toml::Value::String("serve".to_string())]),
);
let mut tools_table = toml::map::Map::new();
for tool_name in tool_names() {
let mut tool_config = toml::map::Map::new();
tool_config.insert(
"approval_mode".to_string(),
toml::Value::String("auto".to_string()),
);
tools_table.insert(tool_name.clone(), toml::Value::Table(tool_config));
}
server_table.insert("tools".to_string(), toml::Value::Table(tools_table));
servers.insert("agentic_ssh".to_string(), toml::Value::Table(server_table));
write_toml_file(config_path, &config)?;
eprintln!(
"\x1b[32m✔\x1b[0m Added agentic_ssh MCP server to {}",
config_path.display()
);
Ok(())
}
fn install_prompt_rules(agents_md: &Path) -> Result<()> {
let marker = "## Prefer agentic_ssh MCP tools";
let existing = if agents_md.exists() {
std::fs::read_to_string(agents_md).unwrap_or_default()
} else {
String::new()
};
if existing.contains(marker) {
if existing.contains("agentic_ssh_context") || existing.contains("knowledge graph") {
uninstall_prompt_rules(agents_md);
} else {
eprintln!(" AGENTS.md already contains agentic_ssh rules, skipping");
return Ok(());
}
}
let mut f = std::fs::OpenOptions::new()
.create(true)
.append(true)
.open(agents_md)
.map_err(|e| AgenticSshError::Config {
message: format!("failed to open AGENTS.md: {e}"),
})?;
write!(
f,
"\n{marker}\n\n\
When you need to discover, query, monitor, or execute commands on remote SSH hosts, \
ALWAYS use the `agentic_ssh` MCP tools:\n\
- **Discovering Hosts:** Use the `list_hosts` tool to retrieve the list of configured remote SSH hosts. Do NOT read or parse `~/.ssh/config` manually.\n\
- **Executing Commands:** Use the `run_command` tool to run shell commands on one or more hosts concurrently.\n\
- **Monitoring Logs:** Use `tail_log` (for files) or `tail_container_logs` (for Docker containers) to read recent logs. To verify startup, services, or events across cluster nodes without polling, use `wait_for_log_pattern` to block and stream logs until a regex pattern is matched.\n\
- **Checking System & Network Status:** Use `get_system_stats` to fetch structured CPU, memory, and disk usage metrics. Use `list_ports` to see active listening TCP/UDP ports. Use `search_processes` to find running processes.\n\
- **Custom Tools:** Use custom commands registered dynamically through the configuration file (e.g., `find_large_files`, `check_service_status`, `check_docker_status`).\n\n\
These tools leverage an automatic connection pool (reusing active sessions and closing them after 5 minutes of inactivity), handle SSH key-based authentication seamlessly, and support output abbreviation to prevent token bloat.\n"
)
.ok();
eprintln!(
"\x1b[32m✔\x1b[0m Appended agentic_ssh rules to {}",
agents_md.display()
);
Ok(())
}
fn uninstall_mcp_server(config_path: &Path) -> Result<()> {
if !config_path.exists() {
return Ok(());
}
let mut config = load_toml_file(config_path)?;
let Some(table) = config.as_table_mut() else {
return Ok(());
};
let Some(servers) = table.get_mut("mcp_servers").and_then(|v| v.as_table_mut()) else {
return Ok(());
};
if servers.remove("agentic_ssh").is_none() {
eprintln!(
" No agentic_ssh MCP server in {}, skipping",
config_path.display()
);
return Ok(());
}
if servers.is_empty() {
table.remove("mcp_servers");
}
if table.is_empty() {
std::fs::remove_file(config_path).ok();
eprintln!(
"\x1b[32m✔\x1b[0m Removed {} (was empty)",
config_path.display()
);
} else {
write_toml_file(config_path, &config)?;
eprintln!(
"\x1b[32m✔\x1b[0m Removed agentic_ssh MCP server from {}",
config_path.display()
);
}
Ok(())
}
fn uninstall_prompt_rules(agents_md: &Path) {
if !agents_md.exists() {
return;
}
let Ok(contents) = std::fs::read_to_string(agents_md) else {
return;
};
if !contents.contains("agentic_ssh") {
eprintln!(" AGENTS.md does not contain agentic_ssh rules, skipping");
return;
}
let marker = "## Prefer agentic_ssh MCP tools";
let Some(start) = contents.find(marker) else {
return;
};
let after_marker = start + marker.len();
let end = contents[after_marker..]
.find("\n## ")
.map_or(contents.len(), |pos| after_marker + pos);
let mut new_contents = String::new();
new_contents.push_str(contents[..start].trim_end());
let remainder = &contents[end..];
if !remainder.is_empty() {
new_contents.push_str("\n\n");
new_contents.push_str(remainder.trim_start());
}
let new_contents = new_contents.trim().to_string();
if new_contents.is_empty() {
std::fs::remove_file(agents_md).ok();
eprintln!(
"\x1b[32m✔\x1b[0m Removed {} (was empty)",
agents_md.display()
);
} else {
std::fs::write(agents_md, format!("{new_contents}\n")).ok();
eprintln!(
"\x1b[32m✔\x1b[0m Removed agentic_ssh rules from {}",
agents_md.display()
);
}
}
fn doctor_check_config(dc: &mut DoctorCounters, config_path: &Path) {
if !config_path.exists() {
dc.warn(&format!(
"{} not found — run `agentic_ssh install --agent codex` if you use Codex CLI",
config_path.display()
));
return;
}
let config = match load_toml_file(config_path) {
Ok(c) => c,
Err(e) => {
dc.fail(&format!("{e}"));
return;
}
};
let has_server = config
.get("mcp_servers")
.and_then(|v| v.get("agentic_ssh"))
.and_then(|v| v.as_table())
.is_some();
if !has_server {
dc.fail(&format!(
"MCP server NOT registered in {} — run `agentic_ssh install --agent codex`",
config_path.display()
));
return;
}
dc.pass(&format!(
"MCP server registered in {}",
config_path.display()
));
let tools = config
.get("mcp_servers")
.and_then(|v| v.get("agentic_ssh"))
.and_then(|v| v.get("tools"))
.and_then(|v| v.as_table());
let auto_count = tools.map_or(0, |t| {
t.values()
.filter(|v| v.get("approval_mode").and_then(|m| m.as_str()) == Some("auto"))
.count()
});
let tools = tool_names();
let tools_len = tools.len();
if auto_count >= tools_len {
dc.pass(&format!("All {tools_len} tools set to auto-approve"));
} else if auto_count > 0 {
dc.warn(&format!(
"{auto_count}/{tools_len} tools auto-approved — run `agentic_ssh install --agent codex` to update"
));
} else {
dc.warn("No tools auto-approved — Codex will prompt for each tool call");
}
}
fn doctor_check_prompt(dc: &mut DoctorCounters, codex_dir: &Path) {
let agents_md = codex_dir.join("AGENTS.md");
if agents_md.exists() {
let has_rules = std::fs::read_to_string(&agents_md)
.unwrap_or_default()
.contains("agentic_ssh");
if has_rules {
dc.pass("AGENTS.md contains agentic_ssh rules");
} else {
dc.fail(
"AGENTS.md missing agentic_ssh rules — run `agentic_ssh install --agent codex`",
);
}
} else {
dc.warn("~/.codex/AGENTS.md does not exist");
}
}