Struct CodexExec 

pub struct CodexExec { /* private fields */ }

Process runner for the Codex CLI.

Implementations

impl CodexExec

pub fn new( executable_path_override: Option<String>, env_override: Option<HashMap<String, String>>, config_overrides: Option<CodexConfigObject>, ) -> Result<Self>

Creates a Codex subprocess runner.

When executable_path_override is not supplied, the executable is discovered from standard local and global install locations.

Example

use codex::CodexExec;

let _exec = CodexExec::new(None, None, None)?;

pub async fn run( &self, args: CodexExecArgs, ) -> Result<BoxStream<'static, Result<String>>>

Runs one codex exec --experimental-json invocation and returns a stream of stdout JSONL lines.

The returned stream yields lines as they arrive and finishes only after the subprocess exits successfully. Non-zero exit status is returned as Error::Process.

Example

use codex::{CodexExec, CodexExecArgs};
use futures::StreamExt;

let exec = CodexExec::new(None, None, None)?;
let mut stream = exec
    .run(CodexExecArgs {
        input: "Say hello".to_string(),
        ..Default::default()
    })
    .await?;

let _first = stream.next().await;

Trait Implementations

impl Clone for CodexExec

fn clone(&self) -> CodexExec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodexExec

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

Formats the value using the given formatter.