Struct Codex 

pub struct Codex { /* private fields */ }

Implementations

impl Codex

pub fn new() -> Self

pub fn set_ephemeral(&mut self, ephemeral: bool)

pub fn set_output_schema(&mut self, schema: Option<String>)

Set a JSON Schema file path for structured output validation.

The Codex CLI’s --output-schema flag accepts a path to a JSON Schema file that constrains the model’s response shape.

pub async fn review( &self, uncommitted: bool, base: Option<&str>, commit: Option<&str>, title: Option<&str>, ) -> Result<()>

Trait Implementations

impl Agent for Codex

fn name(&self) -> &str

fn default_model() -> &'static str

fn model_for_size(size: ModelSize) -> &'static str

Get the model name for a given size category.

fn available_models() -> &'static [&'static str]

Get the list of available models for this agent.

fn system_prompt(&self) -> &str

fn set_system_prompt(&mut self, prompt: String)

fn get_model(&self) -> &str

fn set_model(&mut self, model: String)

fn set_root(&mut self, root: String)

fn set_skip_permissions(&mut self, skip: bool)

fn set_output_format(&mut self, format: Option<String>)

fn set_add_dirs(&mut self, dirs: Vec<String>)

Set additional directories for the agent to include.

fn set_env_vars(&mut self, vars: Vec<(String, String)>)

Set environment variables to pass to the agent subprocess.

fn set_capture_output(&mut self, capture: bool)

Enable output capture mode.

fn set_sandbox(&mut self, config: SandboxConfig)

Set sandbox configuration for running inside a Docker sandbox.

fn set_max_turns(&mut self, turns: u32)

Set the maximum number of agentic turns.

fn as_any_ref(&self) -> &dyn Any

Get a reference to the concrete agent type (for downcasting).

fn as_any_mut(&mut self) -> &mut dyn Any

Get a mutable reference to the concrete agent type (for downcasting).

fn run<'life0, 'life1, 'async_trait>( &'life0 self, prompt: Option<&'life1 str>, ) -> Pin<Box<dyn Future<Output = Result<Option<AgentOutput>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Run the agent in non-interactive mode.

fn run_interactive<'life0, 'life1, 'async_trait>( &'life0 self, prompt: Option<&'life1 str>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn run_resume_with_prompt<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, session_id: &'life1 str, prompt: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<Option<AgentOutput>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Resume a previous session with a new prompt (for retry/correction).

fn run_resume<'life0, 'life1, 'async_trait>( &'life0 self, session_id: Option<&'life1 str>, last: bool, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Resume a previous session.

fn cleanup<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn resolve_model(model_input: &str) -> String

where Self: Sized,

Resolve a model input (either a size alias or specific model name).

fn validate_model(model: &str, agent_name: &str) -> Result<()>

where Self: Sized,

Validate that a model name is supported by this agent.

impl Default for Codex

fn default() -> Self

Returns the “default value” for a type.