Docs: rollout_budget documents stale reminder_interval_tokens key
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 58/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- rust
- Domain
- cli, documentation
Research direction
Start with the published configuration reference and compare its rollout_budget entry with codex-rs/core/config.schema.json and the rust-v0.144.1/current main definitions. Update the reference and sample to use reminder_at_remaining_tokens with an integer array, document the threshold constraints, and remove the obsolete default claim. Done means the published configuration matches the current schema and parses successfully.
Written by the indexing model from the issue text.
Description
Summary
The published Codex configuration reference documents the stale
features.rollout_budget.reminder_interval_tokens key, but Codex CLI expects
features.rollout_budget.reminder_at_remaining_tokens as an array of explicit
remaining-token thresholds.
Documentation:
https://learn.chatgpt.com/docs/config-file/config-reference#configtoml
This makes the documented TOML fail to parse and prevents users from enabling
the under-development rollout_budget feature from the published reference.
Environment
- Codex CLI:
0.144.1 - OS: Windows
- The same
reminder_at_remaining_tokensfield is present in the
rust-v0.144.1tag and currentmain.
Reproduction
Using the key currently listed in the configuration reference:
[features.rollout_budget]
enabled = true
limit_tokens = 100000
reminder_interval_tokens = 10000
Equivalent one-off CLI reproduction:
codex -c 'features.rollout_budget.enabled=true' \
-c 'features.rollout_budget.limit_tokens=100000' \
-c 'features.rollout_budget.reminder_interval_tokens=10000' \
features list
Observed result:
Error: data did not match any variant of untagged enum FeatureToml
in `features.rollout_budget`
Implemented configuration
The CLI accepts the following configuration instead:
[features.rollout_budget]
enabled = true
limit_tokens = 100000
reminder_at_remaining_tokens = [50000, 25000, 10000]
sampling_token_weight = 1.0
prefill_token_weight = 1.0
With the equivalent one-off overrides, codex features list exits successfully
and reports:
rollout_budget under development true
Root cause
PR #29423 intentionally replaced the interval configuration with explicit
remaining-token reminder thresholds:
https://github.com/openai/codex/pull/29423
The implementation and generated schema now use:
pub reminder_at_remaining_tokens: Option<Vec<i64>>,
The published configuration reference still lists:
features.rollout_budget.reminder_interval_tokens- type: integer
- a claimed default of 10% of
limit_tokens
Those statements describe the pre-#29423 implementation.
Suggested documentation fix
- Replace
features.rollout_budget.reminder_interval_tokenswith
features.rollout_budget.reminder_at_remaining_tokens. - Change the documented type from integer to
array<integer>. - Explain that every threshold must be positive and below
limit_tokens. - Remove the old claim that the interval defaults to 10% of
limit_tokens;
the current implementation requires the threshold array when the feature is
enabled. - Update the sample configuration to use an explicit array such as
[50000, 25000, 10000]. - If practical, validate published config keys against
codex-rs/core/config.schema.jsonto catch future drift.
Contribution offer
I have read docs/contributing.md and understand that external pull requests
are accepted by invitation only. If a Codex team member invites me to
contribute this fix, I would be happy to submit a focused documentation PR with
the updated reference/sample and any requested validation coverage.
- Dominant language
- Rust
- Stars
- 125k
- Forks
- 19.5k
- Avg merge
- 1m
- Merged PRs (30d)
- 1k
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from openai/codex
-
enhancement remote
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
bug CLI windows-os
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
macOS sandbox blocks hw.optional.arm64 sysctl, causing Flutter to misdetect Apple Silicon as x64 Openbug CLI sandbox
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
bug CLI TUI
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
CLI config enhancement skills
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
kwakseongjae/auto-hwp#319 ·
-
area:cli bug filter-quality good first issue priority:medium
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
bevyengine/bevy#25861 ·
-
comp-datalake
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
ClickHouse/ClickHouse#121222 ·
-
A-linter
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
oxc-project/oxc#26863 ·