Skip to content

[FEATURE] Add Command-line Tab Completion to AsyncAPI CLI #1685

@gambhirsharma

Description

@gambhirsharma

Why do we need this improvement?

While using the AsyncAPI CLI for the first time, I found it frustrating to repeatedly use the --help flag to look up commands. To address this, I proposed adding a feature to improve the user experience.

I initially started a discussion, but since it hasn't received any responses, I decided to create an issue instead. I also checked for duplicate issues and couldn't find any, so I went ahead with opening this one.

How will this change help?

This feature will significantly improve the user experience when working with the AsyncAPI CLI by:

  • Making the CLI more discoverable - users can press tab to see what commands are available
  • Reducing cognitive load - users don't need to memorize all commands and options
  • Speeding up command entry - especially for long command names or complex option combinations
  • Bringing the CLI in line with industry standards - most popular CLI tools support tab completion
  • Improving accessibility for new users - making it easier to explore the tool's capabilities

Screenshots

No response

How could it be implemented/designed?

As the AsyncAPI CLI uses the oclif framework, adding tab completion is straightforward using the @oclif/plugin-autocomplete plugin.

🚧 Breaking changes

No

👀 Have you checked for similar open issues?

  • I checked and didn't find a similar issue

🏢 Have you read the Contributing Guidelines?

Are you willing to work on this issue?

Yes I am willing to submit a PR!

Metadata

Metadata

Labels

bountyAsyncAPI Bounty program related labelenhancementNew feature or requestlevel/mediumAsyncAPI Bounty program related label

Type

No type

Projects

Status

Completed

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions