Skip to main content

ReviewCommand

Struct ReviewCommand 

Source
pub struct ReviewCommand { /* private fields */ }
Expand description

Run a code review non-interactively (codex exec review).

§Why not codex review

codex-cli exposes review at two paths, codex review and codex exec review. They are the same command: same [PROMPT] positional, same non-interactive behavior, and a byte-identical error when no review scope is given.

They are not equally capable. As of 0.145.0, top-level codex review accepts a strict subset of the flags, missing ten that codex exec review has:

--dangerously-bypass-approvals-and-sandbox   --json
--dangerously-bypass-hook-trust              --output-schema <FILE>
--ephemeral                                  --skip-git-repo-check
--ignore-rules                               -m, --model <MODEL>
--ignore-user-config                         -o, --output-last-message <FILE>

Nothing is available on codex review that is not also on codex exec review, and the missing flags are rejected outright rather than silently ignored.

--json is the decisive one: execute_json_lines depends on it, so a builder targeting the top-level path could not offer structured output at all. This wrapper therefore targets codex exec review only. Use RawCommand if you need the literal codex review invocation.

tests/contract.rs asserts the subset relationship still holds, so if the two surfaces ever diverge the other way, CI reports it.

Implementations§

Source§

impl ReviewCommand

Source

pub fn new() -> Self

Source

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

Source

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

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

Because -c is last-wins, a key set here overrides the same key set by approval_policy, search_mode, or full_auto.

Source

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.

Source

pub fn search(self) -> Self

Enable live web search.

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

Source

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.

Source

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

Source

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

Source

pub fn uncommitted(self) -> Self

Source

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

Source

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

Source

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

Source

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

Source

pub fn strict_config(self) -> Self

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

Source

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 review has no --sandbox flag, so this sets the equivalent config key.

Source

pub fn skip_git_repo_check(self) -> Self

Source

pub fn ephemeral(self) -> Self

Source

pub fn ignore_user_config(self) -> Self

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

Source

pub fn ignore_rules(self) -> Self

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

Source

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

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

Source

pub fn json(self) -> Self

Source

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

Source

pub fn retry(self, policy: RetryPolicy) -> Self

Source

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

Source

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

Execute the review and return a typed QueryResult.

Review emits the same event vocabulary as codex exec, so the review comments arrive as the agent_message item that result is assembled from. Use execute_json_lines for the raw stream. Requires the json feature.

One difference from exec, observed on codex-cli 0.145.0: the turn.completed event of a review reports a usage object of all zeros, so usage is present but carries no counts.

Trait Implementations§

Source§

impl Clone for ReviewCommand

Source§

fn clone(&self) -> ReviewCommand

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl CodexCommand for ReviewCommand

Source§

type Output = CommandOutput

The type returned on success.
Source§

fn args(&self) -> Vec<String>

Build the argument list for this command.
Source§

async fn execute(&self, codex: &Codex) -> Result<CommandOutput>

Execute the command against the given Codex client.
Source§

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

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

impl Dangerous for ReviewCommand

Source§

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

Disable every approval prompt and the sandbox (--dangerously-bypass-approvals-and-sandbox). Read more
Source§

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

Let configured hooks run without the trust prompt (--dangerously-bypass-hook-trust). Read more
Source§

impl Debug for ReviewCommand

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ReviewCommand

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more