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 the CLI usage guide to now detail the new proxy configuration options (--proxyHost and --proxyPort) for several commands, enhancing clarity around how to specify proxy settings when executing commands.

[coderabbitai]

Warning

Rate limit exceeded

@asyncapi-bot has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 51 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

📥 Commits

Reviewing files that changed from the base of the PR and between 3ddf70c and cc7c475.

📒 Files selected for processing (1)

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

Walkthrough

The pull request updates the AsyncAPI CLI documentation and command signatures to include new proxy configuration options. The changes introduce two additional flags, --proxyHost and --proxyPort, for several commands including asyncapi generate fromTemplate, asyncapi generate models, asyncapi validate, and asyncapi optimize. The documentation in the CLI usage file is revised to inform users about these enhancements, and the respective command files are updated to accept and process these new flags.

Changes

File(s)	Change Summary
markdown/docs/.../cli/usage.md	Updated CLI documentation to add details for new proxy flags (--proxyHost, --proxyPort) applied to asyncapi generate fromTemplate, generate models, validate, and optimize commands.
src/commands/generate/fromTemplate.ts, src/commands/generate/models.ts, src/commands/optimize.ts, src/commands/validate.ts	Modified command signatures to include new proxy flags, ensuring that the CLI correctly processes proxy configurations.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant CLI as AsyncAPI CLI
    participant Core as AsyncAPI Core

    U->>CLI: Execute command with proxy flags
    CLI->>CLI: Parse and validate flags (--proxyHost, --proxyPort)
    CLI->>Core: Invoke command with proxy settings
    Core-->>CLI: Return command result
    CLI-->>U: Display output

Loading

Possibly related PRs

• docs(cli): update latest cli documentation #3435 – The changes in the main PR, which add new proxy-related flags to several AsyncAPI CLI commands, are directly related to the command signatures modified in this PR, which also updates documentation for those commands.
• docs(cli): update latest cli documentation #3686 – The changes in the main PR are directly related to those in this PR, as both introduce the same new flags --proxyHost and --proxyPort to the same commands in the CLI documentation.
• docs(cli): update latest cli documentation #3551 – The changes in the main PR are directly related to the modifications made to the asyncapi optimize and asyncapi validate commands in this PR, as both introduce the same new flags --proxyHost and --proxyPort to these commands.

Suggested reviewers

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

Poem

I'm a little rabbit, hopping on the line,
New proxy flags make our CLI shine.
AsyncAPI commands now sport extra grace,
With host and port in their rightful place.
Carrots and commits, let's celebrate the pace!

---

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	cc7c475
🔍 Latest deploy log	https://app.netlify.com/sites/asyncapi-website/deploys/67b049a787b857000842dece
😎 Deploy Preview	https://deploy-preview-3686--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 (3ddf70c) to head (cc7c475).
Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff            @@
##            master     #3686   +/-   ##
=========================================
  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.