Struct Cli 

pub struct Cli {

    pub images: Vec<PathBuf>,
    pub model: Option<String>,
    pub oss: bool,
    pub sandbox_mode: Option<SandboxModeCliArg>,
    pub config_profile: Option<String>,
    pub full_auto: bool,
    pub dangerously_bypass_approvals_and_sandbox: bool,
    pub cwd: Option<PathBuf>,
    pub skip_git_repo_check: bool,
    pub config_overrides: CliConfigOverrides,
    pub color: Color,
    pub json: bool,
    pub last_message_file: Option<PathBuf>,
    pub prompt: Option<String>,
}

Fields

images: Vec<PathBuf>

Optional image(s) to attach to the initial prompt.

model: Option<String>

Model the agent should use.

oss: bool

sandbox_mode: Option<SandboxModeCliArg>

Select the sandbox policy to use when executing model-generated shell commands.

config_profile: Option<String>

Configuration profile from config.toml to specify default options.

full_auto: bool

Convenience alias for low-friction sandboxed automatic execution (-a on-failure, –sandbox workspace-write).

dangerously_bypass_approvals_and_sandbox: bool

Skip all confirmation prompts and execute commands without sandboxing. EXTREMELY DANGEROUS. Intended solely for running in environments that are externally sandboxed.

cwd: Option<PathBuf>

Tell the agent to use the specified directory as its working root.

skip_git_repo_check: bool

Allow running Codex outside a Git repository.

config_overrides: CliConfigOverrides

color: Color

Specifies color settings for use in the output.

json: bool

Print events to stdout as JSONL.

last_message_file: Option<PathBuf>

Specifies file where the last message from the agent should be written.

prompt: Option<String>

Initial instructions for the agent. If not provided as an argument (or if - is used), instructions are read from stdin.

Trait Implementations

impl Args for Cli

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl CommandFactory for Cli

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for Cli

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

Formats the value using the given formatter.

impl FromArgMatches for Cli

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Cli

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.