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

Change --completion-script-bash option to completion bash by convention #969

Open
erhhung opened this issue Jan 15, 2024 · 0 comments
Open
Labels
proposal Enhancement idea or proposal

Comments

@erhhung
Copy link
Contributor

erhhung commented Jan 15, 2024

Proposed change

For new users especially, the shell auto-completion feature is invaluable. However, it was not obvious to discover whether this CLI tool even supported completions as it doesn't appear to be documented in its --help output. I had to search around to see the --completion-script-bash global option randomly mentioned in an issue discussion, and then determine by trial-and-error which additional shells were supported.

By popular convention, shell completion can be enabled by sourcing the output of the completion <shell> subcommand, and should be clearly documented in the help output, exactly as the sister command nsc has done.

Use case

Better discoverability and user experience.

Contribution

No response

@erhhung erhhung added the proposal Enhancement idea or proposal label Jan 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
proposal Enhancement idea or proposal
Projects
None yet
Development

No branches or pull requests

1 participant