diff -r 8f478162d991 -r 05c40b36d3b2 vendor/github.com/spf13/cobra/shell_completions.md --- a/vendor/github.com/spf13/cobra/shell_completions.md Thu Sep 22 16:37:07 2022 +0200 +++ b/vendor/github.com/spf13/cobra/shell_completions.md Sat Feb 04 12:58:35 2023 +0100 @@ -99,6 +99,11 @@ rootCmd.CompletionOptions.DisableDefaultCmd = true ``` +To tell Cobra to mark the default `completion` command as *hidden*: +``` +rootCmd.CompletionOptions.HiddenDefaultCmd = true +``` + To tell Cobra *not* to provide the user with the `--no-descriptions` flag to the completion sub-commands: ``` rootCmd.CompletionOptions.DisableNoDescFlag = true @@ -530,6 +535,21 @@ $ helm s[tab] search show status ``` +### Aliases + +You can also configure `powershell` aliases for your program and they will also support completions. + +``` +$ sal aliasname origcommand +$ Register-ArgumentCompleter -CommandName 'aliasname' -ScriptBlock $__origcommandCompleterBlock + +# and now when you run `aliasname` completion will make +# suggestions as it did for `origcommand`. + +$ aliasname +completion firstcommand secondcommand +``` +The name of the completer block variable is of the form `$__CompleterBlock` where every `-` and `:` in the program name have been replaced with `_`, to respect powershell naming syntax. ### Limitations