docs(cost): clarify ChatGPT allowance semantics - #559
Open
sylvesterkaczmarek wants to merge 2 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Clarify what Codex Security's USD cost estimate and
--max-costmean when a scan uses ChatGPT authentication.Addresses the remaining documentation/UX portion of #29.
Reproduction / evidence
Issue #29 describes a ChatGPT-authenticated scan where the CLI showed an estimated USD cost while the user's ChatGPT Codex allowance changed independently. A maintainer later confirmed that the polling backlog was fixed separately, while the distinction between API-equivalent USD estimates and ChatGPT allowance remained unresolved.
Current documentation says that
--max-costlimits estimated USD model cost, but does not explain that this is a pricing-based estimate rather than ChatGPT plan-allowance telemetry.Root cause
The CLI exposes one model-cost estimate derived from observed token usage and pricing. The documentation did not state the boundary of that metric when authentication comes from a ChatGPT subscription.
Fix
The root README now states that:
--max-costare API-equivalent model-cost estimates based on observed token usage and model pricing;--max-costdoes not cap that allowance;This deliberately does not claim that Codex Security can retrieve plan-allowance telemetry that it does not currently expose.
Tests / validation
Documentation-only change: 7 added lines in the root README. The branch is based directly on current upstream
mainat37bf87a692fc72d41f7312cc48808d699d204fbaand is not behind it.No runtime behavior or generated artifacts are changed.
Risk
Low. This is documentation-only and narrows an ambiguous interpretation of the existing cost display without changing budget enforcement.