2021-03-24 18:07:58 +00:00
|
|
|
package main
|
|
|
|
|
|
|
|
import (
|
|
|
|
"os"
|
|
|
|
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
)
|
|
|
|
|
|
|
|
func NewCompletionCmd() *cobra.Command {
|
2024-01-03 09:55:41 +00:00
|
|
|
completionCmd := &cobra.Command{
|
2022-05-17 10:14:59 +00:00
|
|
|
Use: "completion [bash|zsh|powershell|fish]",
|
2021-03-24 18:07:58 +00:00
|
|
|
Short: "Generate completion script",
|
|
|
|
Long: `To load completions:
|
|
|
|
|
|
|
|
### Bash:
|
2021-08-31 13:03:47 +00:00
|
|
|
` + "```shell" + `
|
2021-03-24 18:07:58 +00:00
|
|
|
$ source <(cscli completion bash)
|
|
|
|
|
|
|
|
# To load completions for each session, execute once:
|
|
|
|
|
|
|
|
|
|
|
|
# Linux:
|
|
|
|
|
|
|
|
$ cscli completion bash | sudo tee /etc/bash_completion.d/cscli
|
2021-07-02 10:16:57 +00:00
|
|
|
$ source ~/.bashrc
|
2021-03-24 18:07:58 +00:00
|
|
|
|
|
|
|
# macOS:
|
|
|
|
|
|
|
|
$ cscli completion bash | sudo tee /usr/local/etc/bash_completion.d/cscli
|
|
|
|
|
2021-07-01 13:03:48 +00:00
|
|
|
# Troubleshoot:
|
|
|
|
If you have this error (bash: _get_comp_words_by_ref: command not found), it seems that you need "bash-completion" dependency :
|
|
|
|
|
|
|
|
* Install bash-completion package
|
|
|
|
$ source /etc/profile
|
|
|
|
$ source <(cscli completion bash)
|
2021-08-31 13:03:47 +00:00
|
|
|
` + "```" + `
|
2021-07-01 13:03:48 +00:00
|
|
|
|
2021-12-28 09:32:46 +00:00
|
|
|
### Zsh:
|
2021-08-31 13:03:47 +00:00
|
|
|
` + "```shell" + `
|
2021-03-24 18:07:58 +00:00
|
|
|
# If shell completion is not already enabled in your environment,
|
|
|
|
# you will need to enable it. You can execute the following once:
|
|
|
|
|
|
|
|
$ echo "autoload -U compinit; compinit" >> ~/.zshrc
|
|
|
|
|
|
|
|
# To load completions for each session, execute once:
|
|
|
|
|
|
|
|
$ cscli completion zsh > "${fpath[1]}/_cscli"
|
|
|
|
|
|
|
|
# You will need to start a new shell for this setup to take effect.
|
2022-05-17 10:14:59 +00:00
|
|
|
|
|
|
|
### fish:
|
|
|
|
` + "```shell" + `
|
|
|
|
$ cscli completion fish | source
|
|
|
|
|
|
|
|
# To load completions for each session, execute once:
|
|
|
|
$ cscli completion fish > ~/.config/fish/completions/cscli.fish
|
|
|
|
` + "```" + `
|
|
|
|
### PowerShell:
|
|
|
|
` + "```powershell" + `
|
|
|
|
PS> cscli completion powershell | Out-String | Invoke-Expression
|
|
|
|
|
|
|
|
# To load completions for every new session, run:
|
|
|
|
PS> cscli completion powershell > cscli.ps1
|
|
|
|
# and source this file from your PowerShell profile.
|
2021-08-31 13:03:47 +00:00
|
|
|
` + "```",
|
2021-03-24 18:07:58 +00:00
|
|
|
DisableFlagsInUseLine: true,
|
2021-08-31 13:03:47 +00:00
|
|
|
DisableAutoGenTag: true,
|
2022-05-17 10:14:59 +00:00
|
|
|
ValidArgs: []string{"bash", "zsh", "powershell", "fish"},
|
2023-04-12 14:58:11 +00:00
|
|
|
Args: cobra.MatchAll(cobra.ExactArgs(1), cobra.OnlyValidArgs),
|
2021-03-24 18:07:58 +00:00
|
|
|
Run: func(cmd *cobra.Command, args []string) {
|
|
|
|
switch args[0] {
|
|
|
|
case "bash":
|
|
|
|
cmd.Root().GenBashCompletion(os.Stdout)
|
|
|
|
case "zsh":
|
|
|
|
cmd.Root().GenZshCompletion(os.Stdout)
|
2022-05-17 10:14:59 +00:00
|
|
|
case "powershell":
|
|
|
|
cmd.Root().GenPowerShellCompletion(os.Stdout)
|
|
|
|
case "fish":
|
2021-03-24 18:07:58 +00:00
|
|
|
cmd.Root().GenFishCompletion(os.Stdout, true)
|
|
|
|
}
|
|
|
|
},
|
|
|
|
}
|
2024-01-03 09:55:41 +00:00
|
|
|
|
2021-03-24 18:07:58 +00:00
|
|
|
return completionCmd
|
|
|
|
}
|