mirror of
https://github.com/openai/codex.git
synced 2026-04-26 15:45:02 +00:00
b16c985ed2
Before this change: ``` tamird@L03G26TD12 codex-rs % codex zsh: do you wish to see all 3864 possibilities (1285 lines)? ``` After this change: ``` tamird@L03G26TD12 codex-rs % codex app-server -- [experimental] Run the app server apply a -- Apply the latest diff produced by Codex agent as a `git apply` to your local working tree cloud -- [EXPERIMENTAL] Browse tasks from Codex Cloud and apply changes locally completion -- Generate shell completion scripts debug -- Internal debugging commands exec e -- Run Codex non-interactively generate-ts -- Internal: generate TypeScript protocol bindings help -- Print this message or the help of the given subcommand(s) login -- Manage login logout -- Remove stored authentication credentials mcp -- [experimental] Run Codex as an MCP server and manage MCP servers mcp-server -- [experimental] Run the Codex MCP server (stdio transport) responses-api-proxy -- Internal: run the responses API proxy resume -- Resume a previous interactive session (picker by default; use --last to continue the most recent) ```
114 lines
4.0 KiB
Rust
114 lines
4.0 KiB
Rust
use clap::Parser;
|
|
use clap::ValueEnum;
|
|
use codex_common::CliConfigOverrides;
|
|
use std::path::PathBuf;
|
|
|
|
#[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", alias = "experimental-json", default_value_t = false)]
|
|
pub 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", short = 'o', value_name = "FILE")]
|
|
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", value_hint = clap::ValueHint::Other)]
|
|
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 {
|
|
/// 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")]
|
|
pub session_id: Option<String>,
|
|
|
|
/// Resume the most recent recorded session (newest) without specifying an id.
|
|
#[arg(long = "last", default_value_t = false, conflicts_with = "session_id")]
|
|
pub last: bool,
|
|
|
|
/// Prompt to send after resuming the session. If `-` is used, read from stdin.
|
|
#[arg(value_name = "PROMPT", value_hint = clap::ValueHint::Other)]
|
|
pub prompt: Option<String>,
|
|
}
|
|
|
|
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, ValueEnum)]
|
|
#[value(rename_all = "kebab-case")]
|
|
pub enum Color {
|
|
Always,
|
|
Never,
|
|
#[default]
|
|
Auto,
|
|
}
|