glenux-archive/spf13--cobra
1
0
Fork 0
mirror of https://github.com/spf13/cobra synced 2025-05-07 13:57:21 +00:00
Code Issues Projects Releases Packages Wiki Activity

doc: add example code of generating Zsh completion

Browse source
This commit is contained in:
autopp 2019-12-24 09:37:17 +09:00
parent b04b5bfc50
commit d234c0b441
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
zsh_completions.md
View file

@ -4,6 +4,14 @@ Cobra supports native Zsh completion generated from the root `cobra.Command`.
The generated completion script should be put somewhere in your `$fpath` named
`_<YOUR COMMAND>`.
```go
// Output to given io.Writer
rootCmd.GenZshCompletion(os.Stdout)
// Output to given file
rootCmd.GenZshCompletionFile("/path/to/fpath/_your_command")
```
### What's Supported
* Completion for all non-hidden subcommands using their `.Short` description.