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 -v as shorthand for --version #1646

Open
2 tasks done
Adi-204 opened this issue Jan 25, 2025 · 2 comments
Open
2 tasks done

[FEATURE] Add -v as shorthand for --version #1646

Adi-204 opened this issue Jan 25, 2025 · 2 comments
Labels
enhancement New feature or request

Comments

@Adi-204
Copy link
Contributor

Adi-204 commented Jan 25, 2025

Why do we need this improvement?

The --version flag is commonly used in CLI tools, but users often expect a shorthand version (-v) for quicker access. Adding -v as an alias for --version will improve the user experience by aligning with industry standards and user expectations for CLI interfaces.

How will this change help?

  1. Enhances usability by providing a quicker way to access the version information.
  2. Improves consistency with other CLI tools that offer both --version and -v options.

Screenshots

Image

--version works fine but -v throws error.

How could it be implemented/designed?

This feature can be implemented by using oclif's built-in support for additionalVersionFlags in the package.json.

🚧 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!

@Adi-204 Adi-204 added the enhancement New feature or request label Jan 25, 2025
@github-project-automation github-project-automation bot moved this to To Triage in CLI - Kanban Jan 25, 2025
Copy link
Contributor

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.

@Adi-204
Copy link
Contributor Author

Adi-204 commented Jan 25, 2025

Waiting for issue approval by maintainers. Please assign me the issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: To Triage
Development

No branches or pull requests

1 participant