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
  • Introduced a new command-line option that allows users to bypass interactive prompts when starting the studio.
• Documentation
  • Updated the CLI usage instructions to include the new flag and enhanced the flag descriptions for improved clarity and consistency.

[coderabbitai]

Walkthrough

The changes update the CLI usage documentation for the asyncapi start studio command by introducing a new flag --no-interactive. This flag disables the interactive prompt for providing a file path when it is not supplied in the command arguments. Additionally, the formatting of existing flag entries has been adjusted for consistency.

Changes

File	Change Summary
markdown/docs/.../usage.md	Added --no-interactive flag to the asyncapi start studio [SPEC-FILE] command and updated formatting of flag descriptions

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant "Interactive Prompt"
    User->>CLI: Run "asyncapi start studio [SPEC-FILE] --no-interactive"
    CLI->>CLI: Check for file path argument
    alt File provided
        CLI->>CLI: Proceed with execution normally
    else No file provided
        CLI->>CLI: Skip interactive prompt (due to --no-interactive flag)
    end
    CLI-->>User: Return execution result

Loading

Possibly related PRs

• docs(cli): update latest cli documentation #3424: Updates to CLI documentation affecting the same usage file.
• docs(cli): update latest cli documentation #3592: Modifications to the command structure for asyncapi start studio in the documentation.
• docs(cli): update latest cli documentation #3713: Enhancements in the CLI usage documentation with flag-related updates.

Suggested labels

autoapproved, autoupdate

Suggested reviewers

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

Poem

Oh, I’m a rabbit, quick and bright,
Hopping through code with delight,
New flag in place to skip the quest,
No prompts to distract, just do our best!
Celebrate each little change with a hop,
And may our code never, ever stop!
🐰✨

---

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	64df88b
🔍 Latest deploy log	https://app.netlify.com/sites/asyncapi-website/deploys/67f63faca9c69d0008d6052f
😎 Deploy Preview	https://deploy-preview-4034--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 (015b1df) to head (64df88b).
Report is 1 commits behind head on master.

Additional details and impacted files

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

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

748-749: Usage Line Update Verification
The usage line now includes the new [--no-interactive] flag, which clearly indicates that users can disable interactive prompts. The integration is straightforward; however, please verify that the spacing between flags (e.g., after [-p <value>]) remains consistent with the overall formatting in the documentation.

---

754-757: New Flag Description Consistency
The new flag --no-interactive is documented as "disable prompts for this command which asks for file path if not passed via the arguments." This description is clear and informative. For consistency, consider aligning the phrasing with similar flags elsewhere in the CLI documentation (for example, the wording used in asyncapi generate fromTemplate).

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 015b1df and 64df88b.

📒 Files selected for processing (1)

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

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

• GitHub Check: Automerge PR autoapproved by a bot
• GitHub Check: Lighthouse CI