Skip to content

Conversation

@SushanthMusham
Copy link

Description

  • Clarified the help description for the --param flag in sharedFlags.ts.
  • The previous text was ambiguous, leading users to encounter errors by guessing formats like key:value.
  • Added an explicit example to the help text: (e.g., --param sidebarOrganization=byTags) to guide users toward the correct key=value syntax.

Related issue(s)
Fixes #1977
Screenshot 2026-02-01 at 10 27 12 PM

@changeset-bot
Copy link

changeset-bot bot commented Feb 1, 2026

🦋 Changeset detected

Latest commit: 3579aa9

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@asyncapi/cli Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@sonarqubecloud
Copy link

sonarqubecloud bot commented Feb 1, 2026

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: To Triage

Development

Successfully merging this pull request may close these issues.

[BUG] Clarify usage format for --param flag in help command

1 participant