Syntax
Flags
Run the review in the foreground and wait for results before returning.
Detach and run the review as a background job. Check progress with
/codex:status.Compare against this git ref instead of the working tree. Accepts a branch name, tag, or commit hash — for example,
main or a specific SHA.Controls what is included in the review. Accepted values:
auto(default) — reviews the working tree if dirty, otherwise compares against the detected default branchworking-tree— always reviews uncommitted changesbranch— compares against the auto-detected default branch (main,master, ortrunk)
Examples
Execution behavior
If you pass neither--wait nor --background, the plugin estimates review size before asking:
- It runs
git statusandgit diff --shortstatto count changed files. - For branch reviews it uses
git diff --shortstat <base>...HEAD. - If the change looks small — roughly 1–2 files — it recommends running in the foreground.
- For everything else, including unclear size, it recommends background.
This command is read-only. It will not fix issues, apply patches, or make any changes to your code.