docs(cli): update latest cli documentation #4205
Conversation
asyncapi-bot
requested review from
TRohit20,
asyncapi-bot-eve and
quetzalliwrites
as code owners
✅ Deploy Preview for asyncapi-website ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughThe CLI usage documentation was updated to reflect AsyncAPI CLI version 3.2.0. Changes include new commands and flags, updated command signatures and descriptions, reordering and swapping of Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant CLI
User->>CLI: asyncapi autocomplete [SHELL]
CLI-->>User: Provides shell autocomplete scripts
User->>CLI: asyncapi generate fromTemplate [ASYNCAPI] [TEMPLATE]
CLI-->>User: Generates output using template (optional args)
User->>CLI: asyncapi start preview [SPEC-FILE] [flags]
CLI-->>User: Starts minimal Studio instance (no editing)
User->>CLI: asyncapi start studio [SPEC-FILE] [flags]
CLI-->>User: Starts full Studio instance (with editing)
User->>CLI: asyncapi validate [flags]
CLI-->>User: Validates AsyncAPI file, applies new warning suppression flags
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #4205 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 22 22
Lines 778 778
Branches 144 144
=========================================
Hits 778 778 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
markdown/docs/tools/cli/usage.md (2)
75-75: Specify fenced code block languages
Several code fences lack a language specifier (lines 75, 456, 778, 807). Please add hints likebash orsh to satisfy markdownlint and improve readability.Also applies to: 456-456, 778-778, 807-807
791-791: Typo in flag description
In the--suppressLogsflag description, "detiled" should be corrected to "detailed".
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
markdown/docs/tools/cli/usage.md(31 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
markdown/docs/tools/cli/usage.md
75-75: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
456-456: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
778-778: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
807-807: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
🪛 LanguageTool
markdown/docs/tools/cli/usage.md
[uncategorized] ~776-~776: Possible missing comma found.
Context: ...new local instance of Studio in minimal state bundling all the refs of the schema fil...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 180000ms (8)
- GitHub Check: Automerge PR autoapproved by a bot
- GitHub Check: Redirect rules - asyncapi-website
- GitHub Check: Header rules - asyncapi-website
- GitHub Check: Pages changed - asyncapi-website
- GitHub Check: Test NodeJS PR - macos-13
- GitHub Check: Test NodeJS PR - ubuntu-latest
- GitHub Check: Lighthouse CI
- GitHub Check: Test NodeJS PR - windows-latest
🔇 Additional comments (8)
markdown/docs/tools/cli/usage.md (8)
30-30: Update CLI version to 3.2.0
The version line has been correctly bumped to@asyncapi/cli/3.2.0.
41-69: Commands list reformatted and new command added
The dash list has been converted to bullets and now includes the newautocompletecommand in the top-level commands list.
71-98: Document newautocompletecommand
Theasyncapi autocomplete [SHELL]section is fully fleshed out with usage, arguments, flags, description, and examples.
458-461: Make ASYNCAPI and TEMPLATE arguments optional
Thegenerate fromTemplatesignature has been updated to[ASYNCAPI] [TEMPLATE], reflecting that both parameters are now optional.
535-536: Add Go-specific flags for model generation
The new--goIncludeCommentsand--goIncludeTagsflags are correctly documented underasyncapi generate models.
774-783: Swapstart previewsection
Theasyncapi start previewheading, description, and usage have been moved and updated per version 3.2.0. The new minimal Studio preview behavior is clearly presented.
803-809: Swapstart studiosection
Theasyncapi start studiocommand has been relocated below preview and its usage and flags now match the full Studio launch behavior.
834-835: Document new validation warning flags
The--suppressAllWarningsand--suppressWarningsflags have been added to thevalidatecommand, aligning docs with CLI functionality.
asyncapi-bot
deleted the
update-cli-docs-400fed2decd2aed138f059c4389cd1d54bf70375
branch
Updated cli documentation is available and this PR introduces update to cli folder on the website
Summary by CodeRabbit
autocompletecommand.generate modelsandvalidatecommands.start studioandstart previewcommands.