docs: fix misleading auth file references (#80)#86
Closed
raylanlin wants to merge 2 commits intoMiniMax-AI:mainfrom
Closed
docs: fix misleading auth file references (#80)#86raylanlin wants to merge 2 commits intoMiniMax-AI:mainfrom
raylanlin wants to merge 2 commits intoMiniMax-AI:mainfrom
Conversation
- SKILL.md: clarify that API key auth persists to config.json, OAuth persists to credentials.json - docs/cli-design.md: rewrite auth section to explain that credentials.json is not required when using API key auth
Remove incorrect claim that $MINIMAX_API_KEY is part of the resolver chain. The env var is checked by ensureApiKey() in main.ts before command execution, and persisted to config.json — it is not directly resolved by resolveCredential().
Contributor
Author
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.
Summary
Fixes #80 — the docs previously implied that
~/.mmx/credentials.jsonis the only auth storage location, which misleads users who authenticate via API key instead.Changes
~/.mmx/config.json, while OAuth persists to~/.mmx/credentials.json.credentials.jsonis not required when using API key auth, and documented the full credential resolution order.Why this matters
Users and agents troubleshooting auth issues would look for
credentials.json, conclude auth is missing, and debug the wrong thing. This change makes the docs accurate for all auth methods.