You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
fix: Update the deprecation message to link to the docs (openai#6211)
The deprecation message is currently a bit confusing. Users may not
understand what is `[features].x`. I updated the docs and the
deprecation message for more guidance.
---------
Co-authored-by: Gabriel Peal <[email protected]>
bail!("OAuth login is only supported when [features].rmcp_client is true in config.toml.");
356
+
bail!(
357
+
"OAuth login is only supported when [features].rmcp_client is true in config.toml. See https://github.com/openai/codex/blob/main/docs/config.md#feature-flags for details."
Copy file name to clipboardExpand all lines: codex-rs/core/src/codex.rs
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -553,7 +553,7 @@ impl Session {
553
553
None
554
554
}else{
555
555
Some(format!(
556
-
"You can either enable it using the CLI with `--enable {canonical}` or through the config.toml file with `[features].{canonical}`"
556
+
"Enable it with `--enable {canonical}` or `[features].{canonical}` in config.toml. See https://github.com/openai/codex/blob/main/docs/config.md#feature-flags for details."
"You can either enable it using the CLI with `--enable streamable_shell` or through the config.toml file with `[features].streamable_shell`"
46
+
"Enable it with `--enable streamable_shell` or `[features].streamable_shell` in config.toml. See https://github.com/openai/codex/blob/main/docs/config.md#feature-flags for details."
Copy file name to clipboardExpand all lines: docs/config.md
+31Lines changed: 31 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,7 @@ Codex configuration gives you fine-grained control over the model, execution env
4
4
5
5
## Quick navigation
6
6
7
+
-[Feature flags](#feature-flags)
7
8
-[Model selection](#model-selection)
8
9
-[Execution environment](#execution-environment)
9
10
-[MCP integration](#mcp-integration)
@@ -26,6 +27,36 @@ Codex supports several mechanisms for setting config values:
26
27
27
28
Both the `--config` flag and the `config.toml` file support the following options:
28
29
30
+
## Feature flags
31
+
32
+
Optional and experimental capabilities are toggled via the `[features]` table in `$CODEX_HOME/config.toml`. If you see a deprecation notice mentioning a legacy key (for example `experimental_use_exec_command_tool`), move the setting into `[features]` or pass `--enable <feature>`.
33
+
34
+
```toml
35
+
[features]
36
+
streamable_shell = true# enable the streamable exec tool
37
+
web_search_request = true# allow the model to request web searches
38
+
# view_image_tool defaults to true; omit to keep defaults
|`ghost_commit`| false | Experimental | Create a ghost commit each turn |
53
+
|`enable_experimental_windows_sandbox`| false | Experimental | Use the Windows restricted-token sandbox |
54
+
55
+
Notes:
56
+
57
+
- Omit a key to accept its default.
58
+
- Legacy booleans such as `experimental_use_exec_command_tool`, `experimental_use_unified_exec_tool`, `include_apply_patch_tool`, and similar `experimental_use_*` keys are deprecated; setting the corresponding `[features].<key>` avoids repeated warnings.
0 commit comments