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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

use std::ffi::OsString;

use crate::{
    ApplyDiffArtifacts, CodexClient, CodexError, PluginCommandRequest, PluginHelpRequest,
    PluginMarketplaceAddRequest, PluginMarketplaceCommandRequest, PluginMarketplaceHelpRequest,
    PluginMarketplaceRemoveRequest, PluginMarketplaceUpgradeRequest,
};

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

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

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

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

    /// Runs `codex plugin marketplace add <SOURCE>` and returns captured output.
    pub async fn plugin_marketplace_add(
        &self,
        request: PluginMarketplaceAddRequest,
    ) -> Result<ApplyDiffArtifacts, CodexError> {
        let PluginMarketplaceAddRequest {
            source,
            source_ref,
            sparse_path,
            overrides,
        } = request;

        let mut args = vec![
            OsString::from("plugin"),
            OsString::from("marketplace"),
            OsString::from("add"),
        ];
        if let Some(source_ref) = source_ref {
            args.push(OsString::from("--ref"));
            args.push(OsString::from(source_ref));
        }
        if let Some(sparse_path) = sparse_path {
            args.push(OsString::from("--sparse"));
            args.push(OsString::from(sparse_path));
        }
        args.push(OsString::from(source));

        self.run_simple_command_with_overrides(args, overrides)
            .await
    }

    /// Runs `codex plugin marketplace remove <MARKETPLACE_NAME>` and returns captured output.
    pub async fn plugin_marketplace_remove(
        &self,
        request: PluginMarketplaceRemoveRequest,
    ) -> Result<ApplyDiffArtifacts, CodexError> {
        let PluginMarketplaceRemoveRequest {
            marketplace_name,
            overrides,
        } = request;

        self.run_simple_command_with_overrides(
            vec![
                OsString::from("plugin"),
                OsString::from("marketplace"),
                OsString::from("remove"),
                OsString::from(marketplace_name),
            ],
            overrides,
        )
        .await
    }

    /// Runs `codex plugin marketplace upgrade [MARKETPLACE_NAME]` and returns captured output.
    pub async fn plugin_marketplace_upgrade(
        &self,
        request: PluginMarketplaceUpgradeRequest,
    ) -> Result<ApplyDiffArtifacts, CodexError> {
        let PluginMarketplaceUpgradeRequest {
            marketplace_name,
            overrides,
        } = request;

        let mut args = vec![
            OsString::from("plugin"),
            OsString::from("marketplace"),
            OsString::from("upgrade"),
        ];
        if let Some(marketplace_name) = marketplace_name {
            args.push(OsString::from(marketplace_name));
        }

        self.run_simple_command_with_overrides(args, overrides)
            .await
    }
}