Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ npx @openai/codex-security scan .
npx @openai/codex-security scan . --patch
npx @openai/codex-security scan . --patch --patch-severity high --json
npx @openai/codex-security scan . --patch --patch-severity high --create-pr
npx @openai/codex-security scan . --patch --review-minimality --review-style --assess-patch-risk
npx @openai/codex-security scan . --model gpt-5.6-terra --effort high
npx @openai/codex-security scan . --scan-prompt-file scan.md --post-scan-prompt-file follow-up.md
npx @openai/codex-security scan . --mode deep --workers 2 --subagents 0 --stop-after-no-new 3 --max-discovery-runs 10 --max-time-hours 1.5
Expand All @@ -38,6 +39,12 @@ Use `--patch --patch-severity high` to fix high and critical findings. Add
verified files and open a draft GitHub pull request. Ordinary scans do not
change repository files.

Add `--review-minimality`, `--review-style`, or `--assess-patch-risk` to
`scan --patch` or `patch` to enable independent, sequential reviews of patch
scope, local coding conventions, and final patch applicability and merge risk.
Each review is optional and disabled by default; risk assessment never merges a
pull request.

Deep-scan discovery stops after 96 hours by default. Set `--max-time-hours` to
any positive number of hours, including fractional hours, up to 96. Completed
findings are preserved and returned when the limit is reached.
Expand Down
8 changes: 8 additions & 0 deletions sdk/typescript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,7 @@ npx @openai/codex-security scan /path/to/repository --headless
npx @openai/codex-security scan /path/to/repository --patch
npx @openai/codex-security scan /path/to/repository --patch --patch-severity high --json
npx @openai/codex-security scan /path/to/repository --patch --patch-severity high --create-pr
npx @openai/codex-security scan /path/to/repository --patch --review-minimality --review-style --assess-patch-risk
npx @openai/codex-security scan /path/to/repository --model gpt-5.6-terra
npx @openai/codex-security scan /path/to/repository --model gpt-5.6-terra --effort high
npx @openai/codex-security scan /path/to/repository --path src --path tests
Expand Down Expand Up @@ -259,6 +260,7 @@ npx @openai/codex-security patch "Missing authorization check" --effort high
npx @openai/codex-security patch OCCURRENCE_ID
npx @openai/codex-security patch --scan SCAN_ID --severity high --json
npx @openai/codex-security patch --scan SCAN_ID --severity high --create-pr
npx @openai/codex-security patch --scan SCAN_ID --review-minimality --review-style --assess-patch-risk
npx @openai/codex-security patch --resume-pr codex-security/patch-SCAN_ID
npx @openai/codex-security patch --scan latest --severity medium
npx @openai/codex-security patch --linear-issue SEC-123 --linear-issue SEC-124
Expand Down Expand Up @@ -359,6 +361,12 @@ saved-finding `patch` command to commit only verified patch files and open a
draft pull request with `gh`. If the push or pull request fails, run the printed
`patch --resume-pr BRANCH` command from the same repository. It uses the saved
commit without running Codex again and refuses to publish if the branch changed.
Add `--review-minimality`, `--review-style`, or `--assess-patch-risk` to either
patching workflow for optional, independent reviews in that order. Minimality
review removes unnecessary or unrelated changes; style review checks project
instructions, local conventions, and applicable style guides; final risk
assessment examines applicability, blast radius, regression protection, and
merge risk without merging the patch. Each stage is disabled by default.
JSON scan results include `patchSeverity`. Scan and
saved-finding results include one `patches` entry per selected finding with
status `verified`, `no_change`, `blocked`, or `failed`, plus `pullRequest` when
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@ Standard scans and Deep Standard scan workers include attack-path analysis direc
## Fix Finding Paths

- Fix report, when using an existing scan artifact directory: `<artifacts_dir>/fix_report.md`
- Patch risk assessment, when requested for a remediation patch: `<artifacts_dir>/patch-risk-assessment.json`

## Placement Rules

Expand Down
Loading
Loading