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

  • Added a new CLI preview command that launches a local, read-only instance of Studio by bundling schema references.
  • Provided configuration options to set base paths, directory resolution, logging preferences, port assignment, and historical reference tracking.

• Documentation

  • Updated CLI usage guidance to include details on the preview command and its associated configuration options.

[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 32 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 dc318a2 and c119274.

📒 Files selected for processing (1)

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

Walkthrough

The pull request updates the CLI usage documentation by introducing a new command asyncapi start preview [SPEC-FILE]. This command launches a local Studio instance in a non-editable, minimal state using the specified schema file. Documentation now includes details on required arguments and multiple flags to configure the behavior of the preview mode.

Changes

File(s)	Change Summary
markdown/docs/tools/cli/usage.md	Added documentation for a new CLI command asyncapi start preview [SPEC-FILE] including its required argument (SPEC-FILE) and additional flags: --base, --baseDir, --help, --suppressLogs, --port, and --xOrigin.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant CLI as CLI
    participant Studio as Studio (Preview Mode)
    
    U->>CLI: Run `asyncapi start preview [SPEC-FILE]` with flags
    CLI->>CLI: Parse command arguments & flags
    CLI->>Studio: Launch minimal Studio instance with bundled schema
    Studio-->>CLI: Send startup confirmation
    CLI-->>U: Display studio launch details (e.g., port info)

Loading

Possibly related PRs

• docs(cli): update latest cli documentation #3552: The changes in the main PR introduce a new command to the CLI documentation, while the retrieved PR updates existing command signatures and descriptions; thus, they are related as they both modify the same documentation file but do not directly alter the same commands or functionalities.
• docs(cli): update latest cli documentation #3693: The changes in the main PR introduce a new command asyncapi start preview [SPEC-FILE], while the retrieved PR updates the existing command asyncapi start studio to include an optional [SPEC-FILE] argument, indicating a direct relationship in modifying command usage in the CLI documentation.
• docs(cli): update latest cli documentation #3592: The changes in the main PR introduce a new command asyncapi start preview [SPEC-FILE], while the retrieved PR updates the existing command asyncapi start studio to include a similar argument for SPEC_FILE, indicating a direct relationship in the context of command modifications.

Suggested reviewers

• quetzalliwrites
• TRohit20
• Aahil13
• VaishnaviNandakumar
• asyncapi-bot-eve

Poem

A happy rabbit hops along the code,
New CLI commands light our humble road,
Preview mode set, the Studio's in play,
With flags and options, it paves the way,
Carrot-crunching while reviews unfold!
🐇🌟

---

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.

❤️ 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.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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	c119274
🔍 Latest deploy log	https://app.netlify.com/sites/asyncapi-website/deploys/67f09f2e79eca30008f6b779
😎 Deploy Preview	https://deploy-preview-4018--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 (dc318a2) to head (c119274).
Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff            @@
##            master     #4018   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           21        21           
  Lines          667       667           
  Branches       113       113           
=========================================
  Hits           667       667           

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

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.