codex-client-sdk 0.107.0

Rust SDK for embedding the Codex agent via CLI-over-JSONL transport
Documentation 
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

use crate::codex_options::CodexOptions;
use crate::errors::Result;
use crate::exec::CodexExec;
use crate::thread::Thread;
use crate::thread_options::ThreadOptions;

/// Entry point for interacting with the Codex agent.
#[derive(Debug, Clone)]
pub struct Codex {
    exec: CodexExec,
    options: CodexOptions,
}

impl Codex {
    /// Creates a new Codex client.
    ///
    /// When `options` is `None`, default options are used and the SDK attempts
    /// to discover the `codex` executable automatically.
    ///
    /// # Example
    ///
    /// ```rust,no_run
    /// use codex::Codex;
    ///
    /// let _codex = Codex::new(None)?;
    /// # Ok::<(), codex::Error>(())
    /// ```
    pub fn new(options: Option<CodexOptions>) -> Result<Self> {
        let options = options.unwrap_or_default();
        let exec = CodexExec::new(
            options.codex_path_override.clone(),
            options.env.clone(),
            options.config.clone(),
        )?;
        Ok(Self { exec, options })
    }

    /// Starts a new thread.
    ///
    /// # Example
    ///
    /// ```rust,no_run
    /// use codex::Codex;
    ///
    /// let codex = Codex::new(None)?;
    /// let _thread = codex.start_thread(None);
    /// # Ok::<(), codex::Error>(())
    /// ```
    pub fn start_thread(&self, options: Option<ThreadOptions>) -> Thread {
        Thread::new(
            self.exec.clone(),
            self.options.clone(),
            options.unwrap_or_default(),
            None,
        )
    }

    /// Resumes an existing thread by id.
    ///
    /// # Example
    ///
    /// ```rust,no_run
    /// use codex::Codex;
    ///
    /// let codex = Codex::new(None)?;
    /// let _thread = codex.resume_thread("thread_123", None);
    /// # Ok::<(), codex::Error>(())
    /// ```
    pub fn resume_thread(&self, id: impl Into<String>, options: Option<ThreadOptions>) -> Thread {
        Thread::new(
            self.exec.clone(),
            self.options.clone(),
            options.unwrap_or_default(),
            Some(id.into()),
        )
    }
}