signald-go/cmd/signaldctl/cmd/completion.go
2021-07-30 18:53:34 +00:00

88 lines
2.6 KiB
Go

// Copyright © 2021 Finn Herzfeld <finn@janky.solutions>
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
package cmd
import (
"os"
"github.com/spf13/cobra"
"gitlab.com/signald/signald-go/cmd/signaldctl/common"
)
var completionCmd = &cobra.Command{
Use: "completion [bash|zsh|fish|powershell]",
Short: "Generate completion script",
Long: `To load completions:
Bash:
$ source <(signaldctl completion bash)
# To load completions for each session, execute once:
# Linux:
$ signaldctl completion bash > /etc/bash_completion.d/signaldctl
# macOS:
$ signaldctl completion bash > /usr/local/etc/bash_completion.d/signaldctl
Zsh:
# 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:
$ signaldctl completion zsh > "${fpath[1]}/_signaldctl"
# You will need to start a new shell for this setup to take effect.
fish:
$ signaldctl completion fish | source
# To load completions for each session, execute once:
$ signaldctl completion fish > ~/.config/fish/completions/signaldctl.fish
PowerShell:
PS> signaldctl completion powershell | Out-String | Invoke-Expression
# To load completions for every new session, run:
PS> signaldctl completion powershell > signaldctl.ps1
# and source this file from your PowerShell profile.
`,
DisableFlagsInUseLine: true,
Annotations: map[string]string{common.AnnotationNoSocketConnection: "true"},
ValidArgs: []string{"bash", "zsh", "fish", "powershell"},
Args: cobra.ExactValidArgs(1),
Run: func(cmd *cobra.Command, args []string) {
switch args[0] {
case "bash":
common.Must(cmd.Root().GenBashCompletion(os.Stdout))
case "zsh":
common.Must(cmd.Root().GenZshCompletion(os.Stdout))
case "fish":
common.Must(cmd.Root().GenFishCompletion(os.Stdout, true))
case "powershell":
common.Must(cmd.Root().GenPowerShellCompletion(os.Stdout))
}
},
}
func init() {
RootCmd.AddCommand(completionCmd)
}