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

use crate::CliOverridesPatch;

/// Selector for `codex help`-style command families.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum HelpScope {
    Root,
    Exec,
    Features,
    Login,
    AppServer,
    Sandbox,
    Cloud,
    Mcp,
}

impl HelpScope {
    pub(crate) fn argv_prefix(&self) -> &'static [&'static str] {
        match self {
            HelpScope::Root => &["help"],
            HelpScope::Exec => &["exec", "help"],
            HelpScope::Features => &["features", "help"],
            HelpScope::Login => &["login", "help"],
            HelpScope::AppServer => &["app-server", "help"],
            HelpScope::Sandbox => &["sandbox", "help"],
            HelpScope::Cloud => &["cloud", "help"],
            HelpScope::Mcp => &["mcp", "help"],
        }
    }
}

/// Request for `codex <scope> help [COMMAND]...`.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct HelpCommandRequest {
    pub scope: HelpScope,
    /// Optional command path components appended after `help` (variadic upstream).
    pub command: Vec<String>,
    /// Per-call CLI overrides layered on top of the builder.
    pub overrides: CliOverridesPatch,
}

impl HelpCommandRequest {
    pub fn new(scope: HelpScope) -> Self {
        Self {
            scope,
            command: Vec::new(),
            overrides: CliOverridesPatch::default(),
        }
    }

    /// Appends one or more command tokens to the help invocation.
    pub fn command<I, S>(mut self, tokens: I) -> Self
    where
        I: IntoIterator<Item = S>,
        S: Into<String>,
    {
        self.command.extend(tokens.into_iter().map(Into::into));
        self
    }

    /// Replaces the default CLI overrides for this request.
    pub fn with_overrides(mut self, overrides: CliOverridesPatch) -> Self {
        self.overrides = overrides;
        self
    }
}