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
1 participant
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.
Fixes #473.
The page claimed the postfix ! means "fail loudly if the env var is missing", but it is a compile-time-only assertion, erased in emitted JavaScript. With the var unset, undefined passes through and fails later in the SDK. Reworded to state what ! actually does and point at the explicit check below it, which is the real loud failure.
Note
Low Risk
Documentation-only correction in auth reference; no runtime or API behavior changes.
Overview
Corrects misleading auth docs around
process.env.CURSOR_API_KEY!in the minimum-viable setup section.The text no longer says the postfix
!will “fail loudly” when the env var is missing. It now states that!is compile-time only (no runtime check), that a missing var yieldsundefinedand a later SDK auth error, and that the explicitif (!apiKey)block below is what actually fails fast at the call site.Reviewed by Cursor Bugbot for commit b492b67. Bugbot is set up for automated code reviews on this repo. Configure here.