Struct ExecResumeCommand 

pub struct ExecResumeCommand { /* private fields */ }

Resume a previous non-interactive session (codex exec resume).

Use session_id to target a specific session, or last to pick the most recent.

Implementations

impl ExecResumeCommand

pub fn new() -> Self

Create a new resume command with no options set.

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

Resume a specific session by its ID.

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

Append an additional prompt to the resumed session.

pub fn from_stdin(prompt: impl Into<String>) -> Self

Create a resume command whose prompt is delivered on stdin.

The prompt is replaced by - in the argument list and written to the child’s stdin instead. Select the session separately with session_id or last.

pub fn prompt_via_stdin(self) -> Self

Deliver this command’s prompt on stdin rather than in argv.

Retry does not apply to a stdin prompt. Any policy set on the command or client is ignored because replaying a consumed pipe would not be a faithful retry.

pub fn last(self) -> Self

Resume the most recent session (--last).

pub fn all(self) -> Self

Resume all sessions (--all).

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 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 json(self) -> Self

Emit JSON Lines output (--json).

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 config(self, key_value: impl Into<String>) -> Self

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

May be called multiple times to set several keys. Because -c is last-wins, a key set here overrides the same key set by approval_policy, search_mode, or full_auto.

pub fn approval_policy(self, policy: impl Into<ApprovalPolicyConfig>) -> Self

Set when the model asks for approval (-c approval_policy="<value>").

codex-cli 0.145.0 removed --ask-for-approval from the exec family; the config key is the supported equivalent. Accepts an ApprovalPolicy directly, or an ApprovalPolicyConfig for the two values the flag never took.

pub fn search(self) -> Self

Enable live web search.

Shorthand for search_mode(WebSearchMode::Live), which is what the removed --search flag meant.

pub fn search_mode(self, mode: WebSearchMode) -> Self

Set the web search mode (-c web_search="<value>").

codex-cli 0.145.0 removed --search from the exec family; the config key is the supported equivalent, and it is an enum rather than the flag’s boolean.

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 rollout_budget(self, budget: RolloutBudgetConfig) -> Self

Enforce a Codex-native rollout-unit budget for this resumed execution.

The meter and response-boundary overshoot are identical to ExecCommand::rollout_budget. Emitting the same config on resume is required: a budget applied only to the opening process does not carry into a later codex exec resume process.

pub fn strict_config(self) -> Self

Error on unrecognized config keys (--strict-config).

pub fn ignore_user_config(self) -> Self

Ignore the user-level config file (--ignore-user-config).

pub fn ignore_rules(self) -> Self

Ignore project rules files (--ignore-rules).

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

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

pub fn full_auto(self) -> Self

Run in full-auto mode, emitted as -c sandbox_mode="workspace-write".

--full-auto is deprecated upstream; codex-cli 0.145.0 hides it and warns to use --sandbox workspace-write instead. codex exec resume has no --sandbox flag, so this sets the equivalent config key.

pub fn skip_git_repo_check(self) -> Self

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

pub fn ephemeral(self) -> Self

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

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 execute_cancellable<C>( &self, codex: &Codex, cancel: C, ) -> Result<CommandOutput>

where C: Future<Output = ()> + Send,

Execute this resumed turn with an explicit cancellation signal.

When cancel resolves, the wrapper terminates the owned process group, awaits the direct child, and then returns Error::Cancelled. The client timeout uses the same settled cleanup path. Retry does not apply to cancellable execution.

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.

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

where C: Future<Output = ()> + Send,

Execute this resumed turn cancellably and parse JSON Lines events.

Automatically appends --json if not already set. Process cleanup is complete before a cancellation or timeout error is returned.

pub async fn execute_json(&self, codex: &Codex) -> Result<QueryResult>

Execute the resume command and return a typed QueryResult.

Assembles the final result text, ids, and token usage from the JSONL event stream. Requires the json feature.

pub async fn execute_json_cancellable<C>( &self, codex: &Codex, cancel: C, ) -> Result<QueryResult>

where C: Future<Output = ()> + Send,

Execute this resumed turn cancellably and return a typed QueryResult.

The wrapper does not return a terminal cancellation or timeout result until process cleanup has completed.

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

where F: FnMut(JsonLineEvent),

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

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

Trait Implementations

impl Clone for ExecResumeCommand

fn clone(&self) -> ExecResumeCommand

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CodexCommand for ExecResumeCommand

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.

fn to_command_string(&self, codex: &Codex) -> String

Render the exact command line this builder will spawn, quoted for a POSIX shell.

impl Dangerous for ExecResumeCommand

fn bypass_approvals_and_sandbox(self, _allow: &DangerousClient) -> Result<Self>

Disable every approval prompt and the sandbox (--dangerously-bypass-approvals-and-sandbox).

fn bypass_hook_trust(self, _allow: &DangerousClient) -> Result<Self>

Let configured hooks run without the trust prompt (--dangerously-bypass-hook-trust).

impl Debug for ExecResumeCommand

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

Formats the value using the given formatter.

impl Default for ExecResumeCommand

fn default() -> Self

Returns the “default value” for a type.