login, logout, auth commands - oauth vs api key auth#16
Conversation
![mesa-dot-dev[bot]](https://avatars.githubusercontent.com/in/1050077?s=60&v=4){kind=small}
There was a problem hiding this comment.
What Changed
This PR introduces a significant update to our authentication documentation, shifting the primary recommendation from API keys to an OAuth 2.0 flow for the CLI. Key changes include:
- Introducing and documenting new CLI commands:
kernel login,kernel logout, andkernel auth. - Restructuring the
quickstart.mdxguide to prioritize the newkernel loginflow. - Updating the
reference/api-keys.mdxandreference/cli.mdxpages to provide comprehensive details on both OAuth and API key authentication methods, including a new 'Authentication Flow' section.
Risks / Concerns
This is a well-executed and thorough documentation update. The only minor point raised during the review was a suggestion to improve the link text in quickstart.mdx for better clarity. Overall, the changes are clear, well-structured, and carry minimal risk. Great work on improving the user authentication experience!
3 files reviewed | 1 comments | Review on Mesa | Edit Reviewer Settings
juecd
left a comment
juecd
left a comment
There was a problem hiding this comment.
Love this overall! Some notes for readability and how to position Oauth vs. API Keys.
| |---------|-------------| | ||
| | `kernel help [command]` | Displays help information about Kernel commands | | ||
|
|
||
| ## Authentication Flow |
There was a problem hiding this comment.
I don't think we need this section - there's a balance in writing docs of conveying enough info without overloading a page, and I think developers know to use a CLI's -h for more info.
There was a problem hiding this comment.
Had this thought on my walk to lunch: this context would be helpful for an LLM. What if we hid it behind a toggle called like "Notes for LLMs"? https://mintlify.com/docs/components/expandables
This could be an interesting docs paradigm that starts emerging.. I feel an interesting tweet coming haha
There was a problem hiding this comment.
Yep, I think we could prob let o3 or something do a pass over the current docs, given some info about making our docs more llm-friendly, and then let it try to update things. Ill add this to linear
…future, but is ok for now)
2 participants
TL;DR
Updated CLI documentation to introduce new
login,logout, andauthcommands, prioritizing OAuth-based authentication as the recommended method.Why we made these changes
To provide clear, up-to-date documentation for Kernel CLI authentication, guiding users to the new, recommended OAuth flow while still supporting API keys.
What changed?
quickstart.mdx: Prioritizedkernel login(OAuth) as the primary authentication method; clarified API key usage.reference/api-keys.mdx: Renamed, expanded on both OAuth and API key methods, and improved API key creation steps.reference/cli.mdx: Reorganized CLI docs, added detailed sections forkernel login,logout, andauthcommands, including an 'Authentication Flow' guide.Validation
login,logout,auth) are accurately documented.