Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
2 tasks done
gambhirsharma opened this issue Mar 1, 2025 · 5 comments
Open
2 tasks done

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

gambhirsharma opened this issue Mar 1, 2025 · 5 comments
Assignees
Labels
bounty AsyncAPI Bounty program related label enhancement New feature or request level/medium AsyncAPI Bounty program related label

Comments

@gambhirsharma
Copy link

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!

@gambhirsharma gambhirsharma added the enhancement New feature or request label Mar 1, 2025
@github-project-automation github-project-automation bot moved this to To Triage in CLI - Kanban Mar 1, 2025
Copy link
Contributor

github-actions bot commented Mar 1, 2025

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup 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.

@Shurtu-gal
Copy link
Collaborator

This had been on my mind for a while now. Found out about https://github.com/oclif/plugin-autocomplete a while back but didn't get a chance to play around with it.

I think this will be pretty cool to have. WDYT? @Souvikns @AayushSaini101

@AayushSaini101 AayushSaini101 self-assigned this Mar 3, 2025
@gambhirsharma
Copy link
Author

@AayushSaini101 Should I start working on the PR?

@AayushSaini101
Copy link
Collaborator

@AayushSaini101 Should I start working on the PR?

We have submitted this idea for a bounty program. You can wait or check other issues. Thanks for the suggestion.feel free to create more enhancement and features request and let me know if you need any help thanks

@AayushSaini101 AayushSaini101 added bounty AsyncAPI Bounty program related label level/medium AsyncAPI Bounty program related label labels Mar 8, 2025
@AayushSaini101
Copy link
Collaborator

I will take this issue for bounty

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bounty AsyncAPI Bounty program related label enhancement New feature or request level/medium AsyncAPI Bounty program related label
Projects
Status: To Triage
Development

No branches or pull requests

3 participants