#shell-completion #clap #completion #bash #fish

clap_autocomplete

Easy to integrate shell completion for Clap. Finds the user's shell and puts completion files in the appropriate locations.

8 releases

0.4.2 Oct 21, 2024
0.4.1 Feb 10, 2023
0.4.0 Oct 17, 2022
0.3.0 Oct 5, 2022
0.1.1 Mar 13, 2022

#347 in Command-line interface

Download history 165/week @ 2024-07-23 146/week @ 2024-07-30 117/week @ 2024-08-06 97/week @ 2024-08-13 334/week @ 2024-08-20 295/week @ 2024-08-27 360/week @ 2024-09-03 345/week @ 2024-09-10 299/week @ 2024-09-17 242/week @ 2024-09-24 213/week @ 2024-10-01 165/week @ 2024-10-08 387/week @ 2024-10-15 330/week @ 2024-10-22 85/week @ 2024-10-29 158/week @ 2024-11-05

982 downloads per month
Used in 3 crates

MIT/Apache

10KB
115 lines

Easy to integrate shell completion for Clap. Finds the user's shell and puts completion files in the appropriate locations.

A library which adds a subcommand to your command. It also checks the matches and returns whether or not the operation succeeded.

Supported shells

This supports the same shells as clap_complete.

It however only supports placing the completion files for Fish, Bash, and Zsh. If the user is using any other shell, they will have to pipe the output into a file.

Documentation

Documentation for releases can be found on docs.rs. Main branch documentation is found on doc.icelk.dev.

Versions

  • 0.1.x: Clap >= 3.1, < 4
  • 0.2.x: Clap >= 3.1, < 4
  • 0.3.x: Clap 4
  • 0.4.x: Clap 4

Changelog

0.4.2

0.4.1

  • Update query-shell dependency.

0.4.0

  • Fix compilation on Windows by disabling automatic writing to shell completions.

0.3.0

  • Update to Clap 4

0.2.1

  • Faster fetching of shell
  • 4 nested dependencies removed

0.2.0

  • Much faster fetching of shell.
  • 20 less dependencies (removed rayon, which was included as part of sysinfo in the old shell fetch crate).
  • Better output of OS errors.
  • Status messages print to stderr.
  • Removed dependency on clap's default features (e.g. regex).

License

Dual-licensed under Apache 2.0 or MIT.

Dependencies

~2–3MB
~57K SLoC