docs(cli): update latest cli documentation

[asyncapi-bot]

Updated cli documentation is available and this PR introduces update to cli folder on the website

Summary by CodeRabbit

• Documentation
  • Updated CLI usage documentation with improved formatting
  • Refined command description for start studio
  • Adjusted command syntax to clarify specification file argument

[coderabbitai]

Walkthrough

The pull request focuses on updating the CLI documentation in the markdown/docs/tools/cli/usage.md file. The changes involve reformatting the command list from asterisk (*) to plus (+) bullet points with improved indentation. Additionally, the start studio command signature has been modified to use a positional argument SPEC_FILE instead of a flag, allowing users to specify the AsyncAPI file path, URL, or context-name more intuitively.

Changes

File	Change Summary
markdown/docs/tools/cli/usage.md	Reformatted command list with plus (+) bullet points and improved readability
src/commands/start/studio.ts	Updated command signature from asyncapi start studio [-h] [-f <value>] to asyncapi start studio [SPEC_FILE] [-h] [-p <value>]

Possibly related PRs

• docs(cli): update latest cli documentation #3552: Updates command signatures and descriptions in CLI documentation
• docs(cli): update latest cli documentation #3576: Modifies CLI documentation with command example updates

Suggested labels

autoapproved, autoupdate

Suggested reviewers

• quetzalliwrites
• VaishnaviNandakumar
• J0SAL
• BhaswatiRoy
• TRohit20
• asyncapi-bot-eve

Poem

🐰 Docs dancing with grace,
Commands lined up in a new space,
Plus signs hop, clarity gleams bright,
Studio's path now takes flight!
A rabbit's guide, crisp and light 🚀

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e9dd904 and 68ad5c5.

📒 Files selected for processing (1)

• markdown/docs/tools/cli/usage.md (2 hunks)

⏰ Context from checks skipped due to timeout of 180000ms (5)

• GitHub Check: Redirect rules - asyncapi-website
• GitHub Check: Header rules - asyncapi-website
• GitHub Check: Pages changed - asyncapi-website
• GitHub Check: Automerge PR autoapproved by a bot
• GitHub Check: Lighthouse CI

🔇 Additional comments (2)

markdown/docs/tools/cli/usage.md (2)

41-69: LGTM! Improved formatting enhances readability.

The change from asterisk (*) to plus (+) bullet points with proper indentation makes the command list more organized and easier to read.

---

791-794: LGTM! Command signature change improves usability.

The change from a flag-based to a positional argument for the spec file path makes the command more intuitive and consistent with other CLI commands.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[netlify]

✅ Deploy Preview for asyncapi-website ready!

Name	Link
🔨 Latest commit	68ad5c5
🔍 Latest deploy log	https://app.netlify.com/sites/asyncapi-website/deploys/678fc875dac35a0008177bd1
😎 Deploy Preview	https://deploy-preview-3592--asyncapi-website.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (e9dd904) to head (68ad5c5).
Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff            @@
##            master     #3592   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           20        20           
  Lines          732       732           
=========================================
  Hits           732       732           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[asyncapi-bot]

⚡️ Lighthouse report for the changes in this PR:

Category	Score
🔴 Performance	34
🟢 Accessibility	98
🟢 Best practices	92
🟢 SEO	100
🔴 PWA	33

Lighthouse ran on https://deploy-preview-3592--asyncapi-website.netlify.app/