uutils/uutils-args
0
0
Fork 0
mirror of https://github.com/uutils/uutils-args.git synced 2026-06-10 16:13:08 -07:00
Code Issues Packages Projects Releases Wiki Activity

document completion generation

Browse Source
This commit is contained in:
Terts Diepraam
2023-12-19 12:10:44 +01:00
parent c8dc4793a0
commit 04131a41c8
1 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/guide/completions.md
+14
View File
@@ -1 +1,15 @@
# Completions
Shell completions and documentation can be generated automatically by this crate. The implementation for this is in the [`uutils-args-complete`] crate. The easiest way of generating completions is via the `parse-is-complete` feature flag. This feature flag hijacks the [`Options::parse`](crate::Options::parse) function to print completions. This means that there is usually no need to write any additional code to generate completions.
```bash
cargo run --features parse-is-complete -- [shell]
```
The `[shell]` value here can be `fish`, `zsh`, `bash`, `powershell`, `elvish` or `nu`.
> **Note**: Some of these remain unimplemented as of writing.
Additionally, the values `man` or `md` can be passed to generate man pages and markdown documentation (for `mdbook`).
If you do not want to hijack the [`Options::parse`](crate::Options::parse) function, you can instead enable the `complete` feature flag. This makes the `Options::complete` function available in addition to the [`Options::parse`](crate::Options::parse) function to generate a `String` with the completion.