docs: document generated CLI .env loading and default auth env vars - #6507
Closed
devin-ai-integration[bot] wants to merge 1 commit into
Closed
docs: document generated CLI .env loading and default auth env vars#6507devin-ai-integration[bot] wants to merge 1 commit into
devin-ai-integration[bot] wants to merge 1 commit into
Conversation
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
|
🌿 Preview your docs: https://fern-preview-devin-1785769805-cli-generator-auth-env.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
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
The CLI generator's Authentication page already covered credential sources and the device-code OAuth
generators.ymlconfig, but two things customers asked about weren't stated: how end users supply credentials via a.envfile, and which environment variable a scheme reads when none is declared.Additions to
fern/products/cli-generator/authentication.mdx:<BINARY>_TOKENfor bearer,<BINARY>_API_KEYfor header API key,<BINARY>_USERNAME/<BINARY>_PASSWORDfor basic,<BINARY>_CLIENT_ID/<BINARY>_CLIENT_SECRETfor OAuth client credentials), and the note that a header API-key scheme also gets an--api-keyflag that wins over its env var..envfiles subsection: the generated CLI auto-loads a.envfile from the working directory or any parent at startup; a.envvalue never overrides an already-set env var. Credential precedence: explicit CLI flag → environment variable →.env.client-idmust be a literal public client ID and addedclient-id-envto the list of rejected fields (alongsideredirect-uriandpkce).No new page or section was created — these fold into the existing canonical auth page.
Checks
pre-commit run --files fern/products/cli-generator/authentication.mdx→ Vale passed, 0 errors.fern check --warnings→ 0 errors (6 pre-existing, unrelated warnings).Link to Devin session: https://app.devin.ai/sessions/7958e622b9224604a134e001984b4239