Struct ExecCommand 

pub struct ExecCommand { /* private fields */ }

Run Codex non-interactively (codex exec <prompt>).

This is the primary command for programmatic use. It supports the full range of exec flags: model selection, sandbox policy, approval policy, images, config overrides, feature flags, JSON output, and more.

Example

use codex_wrapper::{Codex, CodexCommand, ExecCommand, SandboxMode};

let codex = Codex::builder().build()?;
let output = ExecCommand::new("fix the failing test")
    .model("o3")
    .sandbox(SandboxMode::WorkspaceWrite)
    .ephemeral()
    .execute(&codex)
    .await?;
println!("{}", output.stdout);

Implementations

impl ExecCommand

pub fn new(prompt: impl Into<String>) -> Self

Create a new exec command with the given prompt.

pub fn from_stdin() -> Self

Read the prompt from stdin (-).

pub fn config(self, key_value: impl Into<String>) -> Self

pub fn enable(self, feature: impl Into<String>) -> Self

pub fn disable(self, feature: impl Into<String>) -> Self

pub fn image(self, path: impl Into<String>) -> Self

pub fn model(self, model: impl Into<String>) -> Self

pub fn oss(self) -> Self

pub fn local_provider(self, provider: impl Into<String>) -> Self

pub fn sandbox(self, sandbox: SandboxMode) -> Self

pub fn approval_policy(self, policy: ApprovalPolicy) -> Self

pub fn profile(self, profile: impl Into<String>) -> Self

pub fn full_auto(self) -> Self

pub fn dangerously_bypass_approvals_and_sandbox(self) -> Self

pub fn cd(self, dir: impl Into<String>) -> Self

pub fn skip_git_repo_check(self) -> Self

pub fn add_dir(self, dir: impl Into<String>) -> Self

pub fn search(self) -> Self

Enable live web search.

pub fn ephemeral(self) -> Self

pub fn output_schema(self, path: impl Into<String>) -> Self

pub fn color(self, color: Color) -> Self

pub fn progress_cursor(self) -> Self

pub fn json(self) -> Self

pub fn output_last_message(self, path: impl Into<String>) -> Self

pub fn retry(self, policy: RetryPolicy) -> Self

pub async fn execute_json_lines( &self, codex: &Codex, ) -> Result<Vec<JsonLineEvent>>

Trait Implementations

impl Clone for ExecCommand

fn clone(&self) -> ExecCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CodexCommand for ExecCommand

type Output = CommandOutput

The type returned on success.

fn args(&self) -> Vec<String>

Build the argument list for this command.

async fn execute(&self, codex: &Codex) -> Result<CommandOutput>

Execute the command against the given Codex client.

impl Debug for ExecCommand

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

Formats the value using the given formatter.