Add CLI autocompletion using clap_complete #2559
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I recently started using
sqlx
(andsqlx-cli
) for a project andnoticed there is no autocompletion.
As it's trivial to add autocompletion to
clap
-based CLIs and I've doneit a bunch of times I would just create a pr.
How to use it
I added a subcommand named
completions
to generate completions on thefly.
clap_complete
theoretically also supports generating completionsat compile time, but as
cargo install
doesn't support installingautocompletion scripts that doesn't really make sense here.
$ sqlx completions bash > path/to/completions
clap_complete
per default supports generating autocompletions forbash
,elvish
,fish
,powershell
, andzsh
.Sadly there is currently no standard way to create completions for
cargo subcommands, so
cargo-sqlx
can't benefit from completions.