https://github.com/icelk/clap_autocomplete
Easy to integrate shell completion for Clap. Finds the user's shell and puts completion files in the appropriate locations.
https://github.com/icelk/clap_autocomplete
Last synced: 11 months ago
JSON representation
Easy to integrate shell completion for Clap. Finds the user's shell and puts completion files in the appropriate locations.
- Host: GitHub
- URL: https://github.com/icelk/clap_autocomplete
- Owner: Icelk
- License: apache-2.0
- Created: 2022-03-13T11:03:05.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-21T18:06:03.000Z (over 1 year ago)
- Last Synced: 2025-04-12T04:53:39.472Z (about 1 year ago)
- Language: Rust
- Size: 24.4 KB
- Stars: 5
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
> 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](https://crates.io/crates/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](https://docs.rs/clap_autocomplete).
Main branch documentation is found on [doc.icelk.dev](https://doc.icelk.dev/clap_autocomplete/clap_autocomplete/).
# 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
- [fix: add print flag to subcommand and set default behavior](https://github.com/Icelk/clap_autocomplete/pull/3)
## 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](LICENSE-APACHE) or [MIT](LICENSE-MIT).