mirror of
https://github.com/openai/codex.git
synced 2026-04-28 10:21:06 +03:00
169 lines
5.4 KiB
Rust
169 lines
5.4 KiB
Rust
use clap::Parser;
|
|
use clap::ValueEnum;
|
|
use clap::error::Error as ClapError;
|
|
use clap::error::ErrorKind as ClapErrorKind;
|
|
use codex_common::CliConfigOverrides;
|
|
use std::path::PathBuf;
|
|
use uuid::Uuid;
|
|
|
|
#[derive(Parser, Debug)]
|
|
#[command(version)]
|
|
pub struct Cli {
|
|
/// Action to perform. If omitted, runs a new non-interactive session.
|
|
#[command(subcommand)]
|
|
pub command: Option<Command>,
|
|
|
|
/// Optional image(s) to attach to the initial prompt.
|
|
#[arg(long = "image", short = 'i', value_name = "FILE", value_delimiter = ',', num_args = 1..)]
|
|
pub images: Vec<PathBuf>,
|
|
|
|
/// Model the agent should use.
|
|
#[arg(long, short = 'm')]
|
|
pub model: Option<String>,
|
|
|
|
#[arg(long = "oss", default_value_t = false)]
|
|
pub oss: bool,
|
|
|
|
/// Select the sandbox policy to use when executing model-generated shell
|
|
/// commands.
|
|
#[arg(long = "sandbox", short = 's', value_enum)]
|
|
pub sandbox_mode: Option<codex_common::SandboxModeCliArg>,
|
|
|
|
/// Configuration profile from config.toml to specify default options.
|
|
#[arg(long = "profile", short = 'p')]
|
|
pub config_profile: Option<String>,
|
|
|
|
/// Convenience alias for low-friction sandboxed automatic execution (-a on-failure, --sandbox workspace-write).
|
|
#[arg(long = "full-auto", default_value_t = false)]
|
|
pub full_auto: bool,
|
|
|
|
/// Skip all confirmation prompts and execute commands without sandboxing.
|
|
/// EXTREMELY DANGEROUS. Intended solely for running in environments that are externally sandboxed.
|
|
#[arg(
|
|
long = "dangerously-bypass-approvals-and-sandbox",
|
|
alias = "yolo",
|
|
default_value_t = false,
|
|
conflicts_with = "full_auto"
|
|
)]
|
|
pub dangerously_bypass_approvals_and_sandbox: bool,
|
|
|
|
/// Tell the agent to use the specified directory as its working root.
|
|
#[clap(long = "cd", short = 'C', value_name = "DIR")]
|
|
pub cwd: Option<PathBuf>,
|
|
|
|
/// Allow running Codex outside a Git repository.
|
|
#[arg(long = "skip-git-repo-check", default_value_t = false)]
|
|
pub skip_git_repo_check: bool,
|
|
|
|
/// Path to a JSON Schema file describing the model's final response shape.
|
|
#[arg(long = "output-schema", value_name = "FILE")]
|
|
pub output_schema: Option<PathBuf>,
|
|
|
|
#[clap(skip)]
|
|
pub config_overrides: CliConfigOverrides,
|
|
|
|
/// Specifies color settings for use in the output.
|
|
#[arg(long = "color", value_enum, default_value_t = Color::Auto)]
|
|
pub color: Color,
|
|
|
|
/// Print events to stdout as JSONL.
|
|
#[arg(
|
|
long = "json",
|
|
default_value_t = false,
|
|
conflicts_with = "experimental_json"
|
|
)]
|
|
pub json: bool,
|
|
|
|
#[arg(
|
|
long = "experimental-json",
|
|
default_value_t = false,
|
|
conflicts_with = "json"
|
|
)]
|
|
pub experimental_json: bool,
|
|
|
|
/// Whether to include the plan tool in the conversation.
|
|
#[arg(long = "include-plan-tool", default_value_t = false)]
|
|
pub include_plan_tool: bool,
|
|
|
|
/// Specifies file where the last message from the agent should be written.
|
|
#[arg(long = "output-last-message")]
|
|
pub last_message_file: Option<PathBuf>,
|
|
|
|
/// Initial instructions for the agent. If not provided as an argument (or
|
|
/// if `-` is used), instructions are read from stdin.
|
|
#[arg(value_name = "PROMPT")]
|
|
pub prompt: Option<String>,
|
|
}
|
|
|
|
#[derive(Debug, clap::Subcommand)]
|
|
pub enum Command {
|
|
/// Resume a previous session by id or pick the most recent with --last.
|
|
Resume(ResumeArgs),
|
|
}
|
|
|
|
#[derive(Parser, Debug)]
|
|
pub struct ResumeArgs {
|
|
/// Prompt to send after resuming the session. If `-` is used, read from stdin.
|
|
#[arg(value_name = "PROMPT", index = 1)]
|
|
pub prompt: Option<String>,
|
|
|
|
/// Resume the most recent recorded session (newest) without specifying an id.
|
|
#[arg(long = "last", default_value_t = false)]
|
|
pub last: bool,
|
|
|
|
/// Conversation/session id (UUID). When provided, resumes this session.
|
|
/// If omitted, use --last to pick the most recent recorded session.
|
|
#[arg(value_name = "SESSION_ID", index = 2)]
|
|
pub session_id: Option<String>,
|
|
}
|
|
|
|
impl ResumeArgs {
|
|
pub fn normalize(&mut self) -> Result<(), ClapError> {
|
|
if self.last {
|
|
if let Some(value) = self.session_id.take() {
|
|
if Self::looks_like_session_id(&value) {
|
|
return Err(ClapError::raw(
|
|
ClapErrorKind::ArgumentConflict,
|
|
"The argument '--last' cannot be used with '[SESSION_ID]'",
|
|
));
|
|
}
|
|
if let Some(existing) = &mut self.prompt {
|
|
if !existing.is_empty() {
|
|
existing.push(' ');
|
|
}
|
|
existing.push_str(&value);
|
|
} else {
|
|
self.prompt = Some(value);
|
|
}
|
|
}
|
|
return Ok(());
|
|
}
|
|
|
|
if self.session_id.is_some() {
|
|
return Ok(());
|
|
}
|
|
|
|
if let Some(value) = self.prompt.take() {
|
|
if Self::looks_like_session_id(&value) {
|
|
self.session_id = Some(value);
|
|
} else {
|
|
self.prompt = Some(value);
|
|
}
|
|
}
|
|
Ok(())
|
|
}
|
|
|
|
fn looks_like_session_id(value: &str) -> bool {
|
|
Uuid::parse_str(value).is_ok()
|
|
}
|
|
}
|
|
|
|
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, ValueEnum)]
|
|
#[value(rename_all = "kebab-case")]
|
|
pub enum Color {
|
|
Always,
|
|
Never,
|
|
#[default]
|
|
Auto,
|
|
}
|