docs(cli): rewrite cli/README.md for accuracy and readability#3202
Open
fnalways wants to merge 1 commit into
Open
docs(cli): rewrite cli/README.md for accuracy and readability#3202fnalways wants to merge 1 commit into
fnalways wants to merge 1 commit into
Conversation
Restructure the CLI README around the three runtime modes (host, user, in-cluster) and fix several inaccuracies in the previous version: - Correct the login flow: interactive password + TOTP via the `--olares-id` flag, not a browser-based login. - Replace the nonexistent `profile current` command with `profile list` / `profile whoami`. - Fix the Linux credential path to `~/.local/share/olares-cli/`. - Mark in-cluster mode as planned to match the current stub in pkg/credential/env_provider.go. Also condense verbose sections, align terminology and Agent Skills descriptions with the developer docs, and clarify install methods. Co-authored-by: Cursor <cursoragent@cursor.com>
|
@fnalways is attempting to deploy a commit to the Lucky's projects Team on Vercel. A member of the Team first needs to authorize it. |
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
Rewrites
cli/README.mdto be more accurate and readable. The previous version had several inaccuracies and was dense in places.--olares-idflag, not a browser-based login.profile currentcommand withprofile list/profile whoami.~/.local/share/olares-cli/.pkg/credential/env_provider.go.Test plan
cli/README.mdon GitHub and confirm headings, tables, and internal links resolve.profile login --olares-id,profile list,profile whoami, install methods) match current CLI behavior.Made with Cursor
Note
Low Risk
Documentation-only change to cli/README.md; no runtime or security behavior is modified.
Overview
Rewrites
cli/README.mdfor clarity and alignment with current CLI behavior, without changing product code.The doc is reorganized around host / user / in-cluster (planned) modes, with shorter install paths (wizard, global npm, npx) and a dedicated Agent Skills section. It corrects user-facing details: interactive
profile login --olares-id(password + TOTP),profile list/profile whoamiinstead ofprofile current, Linux token storage at~/.local/share/olares-cli/, and-o jsonshorthand. Long scenario tables, wizard edge cases, and duplicate “Linux host side-by-side” prose are trimmed or merged into one special-case block; security, command layering, and repo layout sections are condensed to match the same mental model.Reviewed by Cursor Bugbot for commit 6abb93f. Bugbot is set up for automated code reviews on this repo. Configure here.