Add documentation for Asgardeo CLI#6130
Open
Pratheep-Srikones wants to merge 5 commits into
Open
Conversation
Contributor
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis PR introduces comprehensive Asgardeo CLI documentation with setup, installation, authentication, and usage instructions. Navigation configuration entries are added in commented-out state, ready to be uncommented following the CLI release. ChangesAsgardeo CLI Documentation
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@en/asgardeo/docs/asgardeo-cli.md`:
- Line 133: Fix the typo in the logout note: change "commnd" to "command" in the
sentence that references the asg logout command (the line containing "Use the
`asg logout` commnd to clear the authentication data of the CLI.").
- Around line 67-161: The markdown under the "Installation" and "Authenticating
the CLI" sections violates markdownlint rules (consecutive headings, ordered
list numbering, fenced codeblock spacing, trailing spaces and inline blank-line
rules). Fix by: normalizing all ordered lists under "Building the Asgardeo CLI
locally" and "Authenticating via an application" to start each sequence at 1
(change the prefixed numbers like 2./3./4. back to 1.), ensure single blank
lines before and after each fenced code block (```bash ... ```), remove extra
blank/consecutive headings (remove stray empty headings between "Authenticating
via an application" and its paragraph), eliminate trailing spaces and stray
characters at code block delimiters, and convert indented code blocks to fenced
code blocks where shown (examples under "For example:" and the TUI snippet) so
the file conforms to MD022/MD029/MD030/MD031/MD009.
In `@en/asgardeo/mkdocs.yml`:
- Line 814: Fix the typo in the release-note comment: locate the comment string
"uncomment after relasing the CLI." in mkdocs.yml and change "relasing" to
"releasing" so it reads "uncomment after releasing the CLI.".
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yml
Review profile: CHILL
Plan: Pro
Run ID: 744eea40-2f8d-4a7d-b506-44281bf07e54
⛔ Files ignored due to path filters (1)
en/asgardeo/docs/assets/img/quick-starts/cli-tool/credentials.pngis excluded by!**/*.png
📒 Files selected for processing (3)
en/asgardeo/docs/asgardeo-cli.mden/asgardeo/mkdocs.ymlen/base.yml
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new documentation page for the Asgardeo CLI, with navigation entries intentionally left commented out until the CLI is released.
Changes:
- Adds a new quick-start style doc page at
en/asgardeo/docs/asgardeo-cli.md. - Adds (commented) nav entry for the new page in
en/asgardeo/mkdocs.yml. - Adds (commented) sidebar icon entry for “Asgardeo CLI” in
en/base.yml.
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 10 comments.
| File | Description |
|---|---|
en/base.yml |
Adds a commented-out nav icon entry for “Asgardeo CLI” (to enable post-release). |
en/asgardeo/mkdocs.yml |
Adds a commented-out nav item pointing to asgardeo-cli.md. |
en/asgardeo/docs/asgardeo-cli.md |
New documentation page describing setup, authentication, and usage of the Asgardeo CLI. |
Contributor
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@en/includes/references/asgardeo-cli.md`:
- Line 29: The sentence "We recommend to set the `Token type` of the Access
Token of this application to `Opaque`, and `Application access token expiry
time` of the application to a preferred value." uses an incorrect verb form
after "recommend"; change it to use a gerund: update the phrase starting with
"We recommend to set the `Token type`..." to "We recommend setting the `Token
type` of the Access Token of this application to `Opaque`, and the `Application
access token expiry time` of the application to a preferred value." so the
section in asgardeo-cli.md uses "setting" and makes the second clause clearer.
- Line 52: Replace the passive sentence "Currently, the CLI can be built from
the source code." with an active-voice present-tense version such as "You can
build the CLI from the source code." Update the line in
en/includes/references/asgardeo-cli.md where that exact sentence appears so the
document uses active voice and directly addresses the user.
- Line 3: The single long sentence starting "The **Asgardeo CLI** helps you
manage identity and access management tasks using terminal commands..." should
be split into 2–3 shorter, plain-language sentences; for example, make one
sentence that states what the Asgardeo CLI does (manages identity and access
tasks via terminal/AI tools), a second that explains how it connects to Asgardeo
Management APIs, and an optional third that lists core automated operations
(creating applications, updating API resources, and managing users, groups, and
roles) without referencing the Console UI or direct API calls.
- Line 13: The paragraph is a long, multi-concept sentence; simplify it by
splitting into shorter sentences and using plain language: describe that the
Asgardeo CLI talks to the Asgardeo Management APIs, state that it needs an
access token with proper scopes, and then explain that you must configure access
by creating a Machine-to-Machine (M2M) application and authorizing API resources
and scopes—rewrite the original sentence into 2–3 clear, short sentences
preserving those points.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yml
Review profile: CHILL
Plan: Pro
Run ID: ed742724-273e-4efa-ad6f-34a66ebd38f9
📒 Files selected for processing (3)
en/asgardeo/docs/references/asgardeo-cli.mden/asgardeo/mkdocs.ymlen/includes/references/asgardeo-cli.md
✅ Files skipped from review due to trivial changes (2)
- en/asgardeo/docs/references/asgardeo-cli.md
- en/asgardeo/mkdocs.yml
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.
Purpose
To add documentation for the Asgardeo CLI tool.
Related PRs
PR for Asgardeo CLI
Test environment
N/A
Security checks