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

Override a config key (-c key=value).

May be called multiple times to set several keys.

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

Enable an optional feature flag (--enable <feature>).

May be called multiple times.

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

Disable an optional feature flag (--disable <feature>).

May be called multiple times.

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

Attach an image to the prompt (--image <path>).

May be called multiple times to attach several images.

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

Set the model to use (--model <model>).

Panics if model is an empty string.

pub fn oss(self) -> Self

Use the OSS model tier (--oss).

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

Use a local model provider (--local-provider <provider>).

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

Set the sandbox policy (--sandbox <mode>).

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

Set the approval policy (--ask-for-approval <policy>).

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

Select a named configuration profile (--profile <name>).

pub fn full_auto(self) -> Self

Run in full-auto mode — no approval prompts (--full-auto).

pub fn dangerously_bypass_approvals_and_sandbox(self) -> Self

Bypass all approval prompts and sandbox restrictions.

Passes --dangerously-bypass-approvals-and-sandbox. Use with caution.

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

Change the working directory before running (--cd <dir>).

pub fn skip_git_repo_check(self) -> Self

Skip the git repository check (--skip-git-repo-check).

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

Add an extra directory to the context (--add-dir <dir>).

May be called multiple times.

pub fn search(self) -> Self

Enable live web search (--search).

pub fn ephemeral(self) -> Self

Run in ephemeral mode — no session is persisted (--ephemeral).

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

Require output to conform to a JSON schema (--output-schema <path>).

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

Control terminal color output (--color <mode>).

pub fn progress_cursor(self) -> Self

Show a progress cursor while the command runs (--progress-cursor).

pub fn json(self) -> Self

Emit JSON Lines output (--json).

When set, stdout will contain one JSON object per line. Use execute_json_lines to parse the events automatically (requires the json feature).

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

Write the last assistant message to a file (--output-last-message <path>).

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

Override the retry policy for this command.

Takes precedence over the client-level policy set on Codex.

pub async fn stream<F>(&self, codex: &Codex, handler: F) -> Result<()>

where F: FnMut(JsonLineEvent),

Stream JSONL events from the command, invoking handler for each parsed JsonLineEvent as it arrives.

Automatically appends --json if not already set. Requires the json feature.

Example

use codex_wrapper::{Codex, ExecCommand, JsonLineEvent};

let codex = Codex::builder().build()?;
ExecCommand::new("what is 2+2?")
    .ephemeral()
    .stream(&codex, |event: JsonLineEvent| {
        println!("{}: {:?}", event.event_type, event.extra);
    })
    .await?;

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

Execute the command and parse the output as JSON Lines events.

Automatically appends --json if not already set. Requires the json feature.

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.