unified-agent-api-codex 0.3.5

Async wrapper around the Codex CLI for programmatic prompting
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
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

use std::ffi::OsString;

use crate::{
    ApplyDiffArtifacts, CodexClient, CodexError, DebugAppServerHelpRequest, DebugAppServerRequest,
    DebugAppServerSendMessageV2Request, DebugCommandRequest, DebugHelpRequest, DebugModelsRequest,
    DebugPromptInputRequest,
};

impl CodexClient {
    /// Runs `codex debug` and returns captured output.
    pub async fn debug(
        &self,
        request: DebugCommandRequest,
    ) -> Result<ApplyDiffArtifacts, CodexError> {
        self.run_simple_command_with_overrides(vec![OsString::from("debug")], request.overrides)
            .await
    }

    /// Runs `codex debug help [COMMAND]...` and returns captured output.
    pub async fn debug_help(
        &self,
        request: DebugHelpRequest,
    ) -> Result<ApplyDiffArtifacts, CodexError> {
        let DebugHelpRequest { command, overrides } = request;
        let mut args = vec![OsString::from("debug"), OsString::from("help")];
        args.extend(command.into_iter().map(OsString::from));
        self.run_simple_command_with_overrides(args, overrides)
            .await
    }

    /// Runs `codex debug app-server` and returns captured output.
    pub async fn debug_app_server(
        &self,
        request: DebugAppServerRequest,
    ) -> Result<ApplyDiffArtifacts, CodexError> {
        self.run_simple_command_with_overrides(
            vec![OsString::from("debug"), OsString::from("app-server")],
            request.overrides,
        )
        .await
    }

    /// Runs `codex debug app-server help [COMMAND]...` and returns captured output.
    pub async fn debug_app_server_help(
        &self,
        request: DebugAppServerHelpRequest,
    ) -> Result<ApplyDiffArtifacts, CodexError> {
        let DebugAppServerHelpRequest { command, overrides } = request;
        let mut args = vec![
            OsString::from("debug"),
            OsString::from("app-server"),
            OsString::from("help"),
        ];
        args.extend(command.into_iter().map(OsString::from));
        self.run_simple_command_with_overrides(args, overrides)
            .await
    }

    /// Runs `codex debug app-server send-message-v2 <USER_MESSAGE>` and returns captured output.
    pub async fn debug_app_server_send_message_v2(
        &self,
        request: DebugAppServerSendMessageV2Request,
    ) -> Result<ApplyDiffArtifacts, CodexError> {
        let DebugAppServerSendMessageV2Request {
            user_message,
            overrides,
        } = request;
        self.run_simple_command_with_overrides(
            vec![
                OsString::from("debug"),
                OsString::from("app-server"),
                OsString::from("send-message-v2"),
                OsString::from(user_message),
            ],
            overrides,
        )
        .await
    }

    /// Runs `codex debug models [--bundled]` and returns captured output.
    pub async fn debug_models(
        &self,
        request: DebugModelsRequest,
    ) -> Result<ApplyDiffArtifacts, CodexError> {
        let DebugModelsRequest { bundled, overrides } = request;
        let mut args = vec![OsString::from("debug"), OsString::from("models")];
        if bundled {
            args.push(OsString::from("--bundled"));
        }
        self.run_simple_command_with_overrides(args, overrides)
            .await
    }

    /// Runs `codex debug prompt-input [--image <FILE>...] [PROMPT]` and returns captured output.
    pub async fn debug_prompt_input(
        &self,
        request: DebugPromptInputRequest,
    ) -> Result<ApplyDiffArtifacts, CodexError> {
        let DebugPromptInputRequest {
            prompt,
            images,
            overrides,
        } = request;
        let mut args = vec![OsString::from("debug"), OsString::from("prompt-input")];
        for image in images {
            args.push(OsString::from("--image"));
            args.push(image.into_os_string());
        }
        if let Some(prompt) = prompt {
            args.push(OsString::from(prompt));
        }
        self.run_simple_command_with_overrides(args, overrides)
            .await
    }
}