feat: auto-completion support (#836)

Signed-off-by: Batuhan Apaydın <[email protected]>
Co-authored-by: Furkan Türkal <[email protected]>
Co-authored-by: Erkan Zileli <[email protected]>

Co-authored-by: Furkan Türkal <[email protected]>
Co-authored-by: Erkan Zileli <[email protected]>

cmd/cosign/cli/commands.go

@@ -77,6 +77,7 @@ func New() *cobra.Command {
 	addInitialize(cmd)
 	addPIVTool(cmd)
 	addVersion(cmd)
+	addCompletion(cmd)
 
 	return cmd
 }

cmd/cosign/cli/completion.go

@@ -0,0 +1,71 @@
+//
+// Copyright 2021 The Sigstore Authors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package cli
+
+import (
+	"os"
+
+	"github.com/spf13/cobra"
+)
+
+func addCompletion(topLevel *cobra.Command) {
+	completionCmd := &cobra.Command{
+		Use:   "completion [bash|zsh|fish|powershell]",
+		Short: "Generate completion script",
+		Long: `To load completions:
+Bash:
+  $ source <(cosign completion bash)
+  # To load completions for each session, execute once:
+  # Linux:
+  $ cosign completion bash > /etc/bash_completion.d/cosign
+  # macOS:
+  $ cosign completion bash > /usr/local/etc/bash_completion.d/cosign
+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:
+  $ cosign completion zsh > "${fpath[1]}/_cosign"
+  # You will need to start a new shell for this setup to take effect.
+fish:
+  $ cosign completion fish | source
+  # To load completions for each session, execute once:
+  $ cosign completion fish > ~/.config/fish/completions/cosign.fish
+PowerShell:
+  PS> cosign completion powershell | Out-String | Invoke-Expression
+  # To load completions for every new session, run:
+  PS> cosign completion powershell > cosign.ps1
+  # and source this file from your PowerShell profile.
+`,
+		DisableFlagsInUseLine: true,
+		ValidArgs:             []string{"bash", "zsh", "fish", "powershell"},
+		Args:                  cobra.ExactValidArgs(1),
+		Run: func(cmd *cobra.Command, args []string) {
+			switch args[0] {
+			case "bash":
+				_ = cmd.Root().GenBashCompletion(os.Stdout)
+			case "zsh":
+				_ = cmd.Root().GenZshCompletion(os.Stdout)
+			case "fish":
+				_ = cmd.Root().GenFishCompletion(os.Stdout, true)
+			case "powershell":
+				_ = cmd.Root().GenPowerShellCompletionWithDesc(os.Stdout)
+			}
+		},
+	}
+
+	topLevel.AddCommand(completionCmd)
+}