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

• New Features

  • Updated CLI version from 2.8.0 to 2.8.1 with enhanced command functionality.
  • Added explicit flags for output file naming in asyncapi diff and asyncapi validate commands.

• Documentation

  • Revised command usage descriptions for clarity and accuracy.
  • Updated command references to reflect the new versioning.

[coderabbitai]

Walkthrough

The pull request updates the documentation for the AsyncAPI CLI, specifically the usage.md file. It increments the version number from 2.8.0 to 2.8.1 and modifies command descriptions to clarify the usage of additional flags, particularly the -o flag for output file naming in the asyncapi diff and asyncapi validate commands. Additionally, all command references have been updated to point to the new version's file paths in the source code.

Changes

File Path	Change Summary
markdown/docs/tools/cli/usage.md	Updated version from 2.8.0 to 2.8.1, clarified command descriptions, and updated command references to the new version.

Possibly related PRs

• docs(cli): update latest cli documentation #3306: Updates the CLI documentation in usage.md, directly related to the changes in the main PR.
• docs(cli): update latest cli documentation #3314: Focuses on version updates and command references in the usage.md file, similar to the main PR.
• docs(cli): update latest cli documentation #3322: Reflects updates to the usage.md documentation for the AsyncAPI CLI, aligning with versioning updates in the main PR.
• docs(cli): update latest cli documentation #3324: Updates the CLI documentation in usage.md to reflect the transition to a new version, consistent with the main PR.
• docs(cli): update latest cli documentation #3366: Updates the CLI documentation for version 2.8.0, directly related to the version increment mentioned in the main PR.
• docs(cli): update latest cli documentation #3333: Updates the CLI documentation for version 2.7.4, relevant due to similar versioning changes in usage.md.

Suggested labels

autoapproved, autoupdate

Suggested reviewers

• quetzalliwrites
• devilkiller-ag
• sambhavgupta0705
• BhaswatiRoy
• J0SAL
• TRohit20
• VaishnaviNandakumar
• asyncapi-bot-eve

🐇 In the garden where bunnies play,
The CLI's new version brightens the day!
With flags now clear and paths up to date,
Hop along, friends, it's time to create!
Version two point eight point one, hooray! 🌼

---

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 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.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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	994d118
🔍 Latest deploy log	https://app.netlify.com/sites/asyncapi-website/deploys/673ca5cc98d3b9000802e4f2
😎 Deploy Preview	https://deploy-preview-3391--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.

[asyncapi-bot]

⚡️ Lighthouse report for the changes in this PR:

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

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.77%. Comparing base (bf857b3) to head (994d118).
Report is 1 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #3391   +/-   ##
=======================================
  Coverage   67.77%   67.77%           
=======================================
  Files          21       21           
  Lines         664      664           
=======================================
  Hits          450      450           
  Misses        214      214           

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

---

🚨 Try these New Features:

• Flaky Tests Detection - Detect and resolve failed and flaky tests
• JS Bundle Analysis - Avoid shipping oversized bundles

[derberg]

/rtm