Struct CodexConfig 

pub struct CodexConfig {
    pub cli_path: Option<PathBuf>,
    pub env: HashMap<String, String>,
    pub config_overrides: ConfigOverrides,
    pub profile: Option<String>,
    pub connect_timeout: Option<Duration>,
    pub close_timeout: Option<Duration>,
    pub version_check_timeout: Option<Duration>,
    pub stderr_callback: Option<StderrCallback>,
}

Top-level configuration for the Codex SDK.

Fields

cli_path: Option<PathBuf>

Path to the codex CLI binary. If None, auto-detected via discovery.

env: HashMap<String, String>

Environment variables to pass to the Codex CLI process.

config_overrides: ConfigOverrides

TOML config overrides.

profile: Option<String>

Config profile name (passed via --profile).

connect_timeout: Option<Duration>

Timeout for CLI process spawn + session init.

close_timeout: Option<Duration>

Timeout for graceful shutdown.

version_check_timeout: Option<Duration>

Timeout for codex --version check.

stderr_callback: Option<StderrCallback>

Stderr callback — invoked with each line of stderr from the CLI.

Implementations

impl CodexConfig

pub fn builder() -> CodexConfigBuilder<((), (), (), (), (), (), (), ())>

Create a builder for building CodexConfig. On the builder, call .cli_path(...)(optional), .env(...)(optional), .config_overrides(...)(optional), .profile(...)(optional), .connect_timeout(...)(optional), .close_timeout(...)(optional), .version_check_timeout(...)(optional), .stderr_callback(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of CodexConfig.

impl CodexConfig

pub fn apply_overrides(&self, args: &mut Vec<String>)

Merge crate-level config overrides into CLI args.

pub fn to_env(&self) -> HashMap<String, String>

Build environment variables for the subprocess.

Trait Implementations

impl Clone for CodexConfig

fn clone(&self) -> CodexConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodexConfig

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

Formats the value using the given formatter.

impl Default for CodexConfig

fn default() -> Self

Returns the “default value” for a type.