Skip to content

OpenAI's Codex Security CLI and TypeScript SDK for finding, validating, and fixing security vulnerabilities. npm: https://www.npmjs.com/package/@openai/codex-security

docs: quote Codex overrides across Windows shells (#2400)

Michael D'Angeloa0f81e119c36
diff --git a/docs/bedrock.md b/docs/bedrock.md
index 5d52a3cb8..6795732e2 100644
--- a/docs/bedrock.md
+++ b/docs/bedrock.md
@@ -53,7 +53,7 @@ An AWS inference request can succeed even when the bundled metadata is incomplet
Bedrock defaults `model_reasoning_summary` to `none` because some models reject
`reasoning.summary`. This setting reaches Deep Scan discovery workers,
including resumes. To request summaries from a model that supports them, add
-`--codex 'model_reasoning_summary="auto"'` to the scan command. This explicit
+`--codex "model_reasoning_summary='auto'"` to the scan command. This explicit
override takes precedence over the default and does not change reasoning effort.
See [native configuration overrides](../sdk/typescript/docs/cli.md#runtime-configuration-and-worker-limits)
for the `--codex KEY=VALUE` syntax.
diff --git a/sdk/typescript/README.md b/sdk/typescript/README.md
index dfc549ff2..953447221 100644
--- a/sdk/typescript/README.md
+++ b/sdk/typescript/README.md
@@ -772,7 +772,7 @@ Local tools running under the same account are trusted.
The scan profile allows reads across the local filesystem and writes to workspace
roots. Execution approvals are reviewed automatically and may grant extra
permissions for an operation. Set `codexOverrides.approval_policy: "never"`
-(or CLI `--codex 'approval_policy="never"'`) to deny permission requests.
+(or CLI `--codex "approval_policy='never'"`) to deny permission requests.
If you select a Codex profile, its explicit `approval_policy` takes precedence
over the root setting.
Host and network restrictions still apply.
diff --git a/sdk/typescript/docs/cli.md b/sdk/typescript/docs/cli.md
index 7acca1bac..b7bc7a76c 100644
--- a/sdk/typescript/docs/cli.md
+++ b/sdk/typescript/docs/cli.md
@@ -974,16 +974,17 @@ executable outside all saved scan targets. If a historical target includes the
available Git installation, use `codex-security dedupe --scan SCAN_ID` with an
explicit saved scan ID. Exact-path `latest` lookup still works without Git.
-Repeat `--codex KEY=VALUE` for supported native settings. Quote strings as TOML:
-`--codex 'model_reasoning_effort="high"'`. Repeated or conflicting keys are
-rejected, including a `--model` or `--effort` flag plus its native equivalent.
+Repeat `--codex KEY=VALUE` for supported native settings. For example,
+`--codex "model_reasoning_effort='high'"` passes the TOML string `high` in Bash,
+Command Prompt, and PowerShell. Repeated or conflicting keys are rejected,
+including a `--model` or `--effort` flag plus its native equivalent.
To select a Codex file profile, put its settings in
`$CODEX_HOME/review.config.toml` (or `~/.codex/review.config.toml` when
`CODEX_HOME` is unset), then run:
```bash
-npx @openai/codex-security scan . --codex 'profile="review"'
+npx @openai/codex-security scan . --codex "profile='review'"
```
In the SDK, set `codexOverrides: { profile: "review" }`. In a project config,
@@ -1009,11 +1010,11 @@ Multi-agent v2 must remain enabled; `agents.max_threads` is unsupported.
```bash
codex-security patch "Security issue" --model gateway-model \
- --codex 'model_provider="gateway"' \
- --codex 'model_providers.gateway.name="Gateway"' \
- --codex 'model_providers.gateway.base_url="https://gateway.example.test/v1"' \
- --codex 'model_providers.gateway.wire_api="responses"' \
- --codex 'model_providers.gateway.env_key="GATEWAY_API_KEY"'
+ --codex "model_provider='gateway'" \
+ --codex "model_providers.gateway.name='Gateway'" \
+ --codex "model_providers.gateway.base_url='https://gateway.example.test/v1'" \
+ --codex "model_providers.gateway.wire_api='responses'" \
+ --codex "model_providers.gateway.env_key='GATEWAY_API_KEY'"
```
Set the provider's key environment variable before running. Patching and
@@ -1045,7 +1046,7 @@ starts, outcomes, duration, and usage coverage; see
[telemetry and measurement](telemetry.md).
Disable Codex usage analytics and built-in metrics with
-`--codex 'analytics.enabled=false'`. The setting carries into `scan --patch`,
+`--codex analytics.enabled=false`. The setting carries into `scan --patch`,
patch-risk assessment, and Deep Scan discovery workers, including
resumed workers. Selected-profile settings take precedence over root settings.
Explicit OpenTelemetry settings also carry into scan patches and Deep Scan