mirror of
https://github.com/spf13/cobra
synced 2024-11-16 18:57:08 +00:00
2c5a0d300f
Replace the current Zsh completion with a Zsh completion solution based
on Go completions. This allows to support custom completions (based
on Go completions), but also to standardize the behavior of completion
across all shells.
Also, add support to Go completions for the bash completion annotations:
BashCompFilenameExt (including Command.MarkFlagFilename() family)
- still supported by zsh
BashCompSubdirsInDir - now supported by zsh
BashCompOneRequiredFlag (including Command.MarkFlagRequired() family)
- now supported by zsh and fish
Finally, remove the suggestin of the = form of flag completion.
The = form is supported, but it will not be suggested to avoid having
duplicated suggestions.
16 lines
1.1 KiB
Markdown
16 lines
1.1 KiB
Markdown
# Generating PowerShell Completions For Your Own cobra.Command
|
|
|
|
Cobra can generate PowerShell completion scripts. Users need PowerShell version 5.0 or above, which comes with Windows 10 and can be downloaded separately for Windows 7 or 8.1. They can then write the completions to a file and source this file from their PowerShell profile, which is referenced by the `$Profile` environment variable. See `Get-Help about_Profiles` for more info about PowerShell profiles.
|
|
|
|
*Note*: PowerShell completions have not (yet?) been aligned to Cobra's generic shell completion support. This implies the PowerShell completions are not as rich as for other shells (see [What's not yet supported](#whats-not-yet-supported)), and may behave slightly differently. They are still very useful for PowerShell users.
|
|
|
|
# What's supported
|
|
|
|
- Completion for subcommands using their `.Short` description
|
|
- Completion for non-hidden flags using their `.Name` and `.Shorthand`
|
|
|
|
# What's not yet supported
|
|
|
|
- Command aliases
|
|
- Required, filename or custom flags (they will work like normal flags)
|
|
- Custom completion scripts
|