Struct CodexOptions 

pub struct CodexOptions {
    pub codex_path_override: Option<String>,
    pub base_url: Option<String>,
    pub api_key: Option<String>,
    pub config: Option<CodexConfigObject>,
    pub env: Option<HashMap<String, String>>,
}

Options for constructing a crate::Codex client.

Fields

codex_path_override: Option<String>

Absolute path to the codex executable.

When omitted, the SDK searches PATH, local node_modules, vendor binaries, and common global install locations.

base_url: Option<String>

Overrides OPENAI_BASE_URL for Codex CLI requests.

api_key: Option<String>

Overrides CODEX_API_KEY for Codex CLI requests.

config: Option<CodexConfigObject>

Additional --config key=value overrides for the Codex CLI.

env: Option<HashMap<String, String>>

Environment variables passed to the Codex CLI process.

When provided, the SDK does not inherit std::env.

Trait Implementations

impl Clone for CodexOptions

fn clone(&self) -> CodexOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CodexOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CodexOptions

fn default() -> CodexOptions

Returns the “default value” for a type.