cli_agents/adapters/codex/
mod.rs1mod parse;
2
3use crate::adapters::CliAdapter;
4use crate::discovery::discover_binary;
5use crate::error::{Error, Result};
6use crate::events::StreamEvent;
7use crate::types::{CliName, RunOptions, RunResult};
8use crate::DEFAULT_MAX_OUTPUT_BYTES;
9use serde::Serialize;
10use std::collections::HashMap;
11use tokio_util::sync::CancellationToken;
12use tracing::warn;
13
14pub struct CodexAdapter;
15
16impl CliAdapter for CodexAdapter {
17 fn name(&self) -> CliName {
18 CliName::Codex
19 }
20
21 async fn run(
22 &self,
23 opts: &RunOptions,
24 emit: &(dyn Fn(StreamEvent) + Send + Sync),
25 cancel: CancellationToken,
26 ) -> Result<RunResult> {
27 let binary = match &opts.executable_path {
28 Some(p) => p.clone(),
29 None => discover_binary(CliName::Codex).await.ok_or(Error::NoCli)?,
30 };
31
32 let (config_env, _tmp_dir) = write_configs(opts).await?;
35
36 let args = build_args(opts);
37 let mut extra_env = opts.env.clone().unwrap_or_default();
38 extra_env.extend(config_env);
39 let max_bytes = opts.max_output_bytes.unwrap_or(DEFAULT_MAX_OUTPUT_BYTES);
40
41 let mut state = parse::ParseState::default();
42 let mut text_tracker: HashMap<String, String> = HashMap::new();
43
44 let outcome = crate::adapters::spawn_and_stream(
45 crate::adapters::SpawnParams {
46 cli_label: "codex",
47 binary: &binary,
48 args: &args,
49 extra_env: &extra_env,
50 cwd: opts.cwd.as_deref().unwrap_or("."),
51 max_bytes,
52 cancel: &cancel,
53 },
54 |line| parse::parse_line(line, &mut state, &mut text_tracker, emit),
55 )
56 .await?;
57
58 match outcome {
59 crate::adapters::SpawnOutcome::Cancelled => Ok(RunResult {
60 success: false,
61 text: Some("Cancelled.".into()),
62 ..Default::default()
63 }),
64 crate::adapters::SpawnOutcome::Done { exit_code, stderr } => {
65 let success = !state.failed && exit_code == 0;
66 let text = if !success && state.result_text.is_none() {
67 crate::adapters::extract_error_message(stderr.as_deref())
68 } else {
69 state.result_text
70 };
71 Ok(RunResult {
72 success,
73 text,
74 exit_code: Some(exit_code),
75 stats: state.stats,
76 session_id: state.session_id,
77 stderr,
78 cost_usd: None,
79 })
80 }
81 }
82 }
83}
84
85fn build_args(opts: &RunOptions) -> Vec<String> {
86 let mut args = vec!["exec".into()];
87
88 if let Some(session_id) = &opts.resume_session_id {
90 args.push("resume".into());
91 args.push(session_id.clone());
92 }
93
94 args.push(opts.task.clone());
95 args.push("--json".into());
96
97 if let Some(model) = &opts.model {
98 args.push("--model".into());
99 args.push(model.clone());
100 }
101
102 if let Some(cwd) = &opts.cwd {
103 args.push("--cd".into());
104 args.push(cwd.clone());
105 }
106
107 let codex_opts = opts.providers.as_ref().and_then(|p| p.codex.as_ref());
108
109 if let Some(co) = codex_opts {
110 if let Some(policy) = &co.approval_policy {
111 match policy.as_str() {
112 "full-auto" => args.push("--full-auto".into()),
113 "suggest" | "auto-edit" => {
114 }
116 other => {
117 warn!(policy = other, "unknown Codex approval policy, ignoring");
118 }
119 }
120 }
121 if let Some(sandbox) = &co.sandbox_mode {
122 args.push("--sandbox".into());
123 args.push(sandbox.clone());
124 }
125 if let Some(dirs) = &co.additional_directories {
126 for dir in dirs {
127 args.push("--cd".into());
128 args.push(dir.clone());
129 }
130 }
131 if let Some(images) = &co.images {
132 for img in images {
133 args.push("--image".into());
134 args.push(img.clone());
135 }
136 }
137 if let Some(schema) = &co.output_schema {
138 args.push("--output-schema".into());
139 args.push(schema.clone());
140 }
141 }
142
143 let has_policy = codex_opts
146 .and_then(|c| c.approval_policy.as_deref())
147 .is_some_and(|p| !p.is_empty());
148 if opts.skip_permissions && !has_policy {
149 args.push("--dangerously-bypass-approvals-and-sandbox".into());
150 }
151
152 args
153}
154
155#[derive(Serialize)]
158struct CodexConfig {
159 #[serde(skip_serializing_if = "Option::is_none")]
160 instructions: Option<String>,
161 #[serde(skip_serializing_if = "Option::is_none")]
162 mcp_servers: Option<HashMap<String, CodexMcpServer>>,
163}
164
165#[derive(Serialize)]
166struct CodexMcpServer {
167 #[serde(skip_serializing_if = "Option::is_none")]
168 command: Option<String>,
169 #[serde(skip_serializing_if = "Option::is_none")]
170 args: Option<Vec<String>>,
171 #[serde(skip_serializing_if = "Option::is_none")]
172 env: Option<HashMap<String, String>>,
173 #[serde(skip_serializing_if = "Option::is_none")]
174 cwd: Option<String>,
175 #[serde(skip_serializing_if = "Option::is_none")]
176 tool_timeout_sec: Option<u64>,
177}
178
179async fn write_configs(
188 opts: &RunOptions,
189) -> Result<(HashMap<String, String>, Option<tempfile::TempDir>)> {
190 let has_mcp = opts.mcp_servers.as_ref().is_some_and(|s| !s.is_empty());
191 let system_prompt = resolve_system_prompt(opts).await?;
192
193 if !has_mcp && system_prompt.is_none() {
194 return Ok((HashMap::new(), None));
195 }
196
197 let tmp_dir = tempfile::tempdir().map_err(Error::Io)?;
198 let codex_dir = tmp_dir.path().join(".codex");
199 tokio::fs::create_dir_all(&codex_dir)
200 .await
201 .map_err(Error::Io)?;
202
203 let config = CodexConfig {
204 instructions: system_prompt,
205 mcp_servers: opts.mcp_servers.as_ref().map(|servers| {
206 servers
207 .iter()
208 .map(|(name, s)| {
209 (
210 name.clone(),
211 CodexMcpServer {
212 command: s.command.clone(),
213 args: s.args.clone(),
214 env: s.env.clone(),
215 cwd: s.cwd.clone(),
216 tool_timeout_sec: s.timeout,
217 },
218 )
219 })
220 .collect()
221 }),
222 };
223
224 let toml_str = toml::to_string_pretty(&config)
225 .map_err(|e| Error::Other(format!("TOML serialization: {e}")))?;
226
227 let config_path = codex_dir.join("config.toml");
228 tokio::fs::write(&config_path, toml_str)
229 .await
230 .map_err(Error::Io)?;
231
232 let mut env = HashMap::new();
233 env.insert(
234 "CODEX_HOME".into(),
235 tmp_dir.path().to_string_lossy().into_owned(),
236 );
237 Ok((env, Some(tmp_dir)))
238}
239
240async fn resolve_system_prompt(opts: &RunOptions) -> Result<Option<String>> {
243 if let Some(path) = &opts.system_prompt_file {
244 let content = tokio::fs::read_to_string(path).await.map_err(|e| {
245 Error::Process(format!("failed to read system prompt file {path}: {e}"))
246 })?;
247 Ok(Some(content))
248 } else {
249 Ok(opts.system_prompt.clone())
250 }
251}
252
253#[cfg(test)]
254mod tests {
255 use super::*;
256
257 #[test]
258 fn build_args_minimal() {
259 let opts = RunOptions {
260 task: "hello".into(),
261 ..Default::default()
262 };
263 let args = build_args(&opts);
264 assert!(args.contains(&"exec".to_string()));
265 assert!(args.contains(&"hello".to_string()));
266 assert!(args.contains(&"--json".to_string()));
267 }
268
269 #[test]
270 fn build_args_no_permission_bypass_by_default() {
271 let opts = RunOptions {
272 task: "hello".into(),
273 ..Default::default()
274 };
275 let args = build_args(&opts);
276 assert!(!args.contains(&"--dangerously-bypass-approvals-and-sandbox".to_string()));
277 }
278
279 #[test]
280 fn build_args_permission_bypass_when_opted_in() {
281 let opts = RunOptions {
282 task: "hello".into(),
283 skip_permissions: true,
284 ..Default::default()
285 };
286 let args = build_args(&opts);
287 assert!(args.contains(&"--dangerously-bypass-approvals-and-sandbox".to_string()));
288 }
289
290 #[test]
291 fn build_args_resume_session() {
292 let opts = RunOptions {
293 task: "continue working".into(),
294 resume_session_id: Some("tid-abc123".into()),
295 ..Default::default()
296 };
297 let args = build_args(&opts);
298 let resume_idx = args.iter().position(|a| a == "resume").unwrap();
300 assert_eq!(args[resume_idx + 1], "tid-abc123");
301 }
302
303 #[test]
304 fn build_args_full_auto() {
305 let opts = RunOptions {
306 task: "fix bug".into(),
307 model: Some("o3".into()),
308 providers: Some(crate::types::ProviderOptions {
309 codex: Some(crate::types::CodexOptions {
310 approval_policy: Some("full-auto".into()),
311 sandbox_mode: Some("workspace-write".into()),
312 ..Default::default()
313 }),
314 ..Default::default()
315 }),
316 ..Default::default()
317 };
318 let args = build_args(&opts);
319 assert!(args.contains(&"--full-auto".to_string()));
320 assert!(args.contains(&"--sandbox".to_string()));
321 assert!(args.contains(&"--model".to_string()));
322 assert!(args.contains(&"o3".to_string()));
323 }
324
325 #[test]
326 fn build_args_full_auto_with_skip_permissions_no_conflict() {
327 let opts = RunOptions {
328 task: "fix bug".into(),
329 skip_permissions: true,
330 providers: Some(crate::types::ProviderOptions {
331 codex: Some(crate::types::CodexOptions {
332 approval_policy: Some("full-auto".into()),
333 ..Default::default()
334 }),
335 ..Default::default()
336 }),
337 ..Default::default()
338 };
339 let args = build_args(&opts);
340 assert!(args.contains(&"--full-auto".to_string()));
341 assert!(
342 !args.contains(&"--dangerously-bypass-approvals-and-sandbox".to_string()),
343 "should not pass both --full-auto and --dangerously-bypass-approvals-and-sandbox"
344 );
345 }
346
347 #[tokio::test]
348 async fn write_configs_creates_mcp_config() {
349 let mut servers = HashMap::new();
350 servers.insert(
351 "test".into(),
352 crate::types::McpServer {
353 command: Some("test-server".into()),
354 args: Some(vec!["--flag".into()]),
355 ..Default::default()
356 },
357 );
358
359 let opts = RunOptions {
360 task: "hello".into(),
361 mcp_servers: Some(servers),
362 ..Default::default()
363 };
364
365 let (env, tmp_dir) = write_configs(&opts).await.unwrap();
366 assert!(env.contains_key("CODEX_HOME"));
367 let tmp = tmp_dir.unwrap();
368
369 let config_path = tmp.path().join(".codex/config.toml");
370 let content = std::fs::read_to_string(&config_path).unwrap();
371 assert!(content.contains("[mcp_servers.test]"));
372 assert!(content.contains("test-server"));
373 }
374
375 #[tokio::test]
376 async fn write_configs_with_system_prompt() {
377 let opts = RunOptions {
378 task: "hello".into(),
379 system_prompt: Some("You are helpful.".into()),
380 ..Default::default()
381 };
382
383 let (env, tmp_dir) = write_configs(&opts).await.unwrap();
384 assert!(env.contains_key("CODEX_HOME"));
385 let tmp = tmp_dir.unwrap();
386
387 let config_path = tmp.path().join(".codex/config.toml");
388 let content = std::fs::read_to_string(&config_path).unwrap();
389 assert!(content.contains("instructions"));
390 assert!(content.contains("You are helpful."));
391 }
392
393 #[tokio::test]
394 async fn write_configs_noop_when_empty() {
395 let opts = RunOptions {
396 task: "hello".into(),
397 ..Default::default()
398 };
399
400 let (env, tmp_dir) = write_configs(&opts).await.unwrap();
401 assert!(env.is_empty());
402 assert!(tmp_dir.is_none());
403 }
404
405 #[tokio::test]
406 async fn write_configs_system_prompt_file_takes_precedence() {
407 let fixture = tempfile::tempdir().unwrap();
408
409 let prompt_file = fixture.path().join("prompt.md");
411 std::fs::write(&prompt_file, "File prompt content").unwrap();
412
413 let opts = RunOptions {
414 task: "hello".into(),
415 system_prompt: Some("Inline prompt".into()),
416 system_prompt_file: Some(prompt_file.to_string_lossy().into_owned()),
417 ..Default::default()
418 };
419
420 let (env, tmp_dir) = write_configs(&opts).await.unwrap();
421 assert!(env.contains_key("CODEX_HOME"));
422 let tmp = tmp_dir.unwrap();
423
424 let config_path = tmp.path().join(".codex/config.toml");
425 let content = std::fs::read_to_string(&config_path).unwrap();
426 assert!(content.contains("File prompt content"));
427 assert!(!content.contains("Inline prompt"));
428 }
429}