Add command line completion (#190)

Author: atluq

cmd/completion.go

@@ -0,0 +1,75 @@
+package cmd
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/spf13/cobra"
+)
+
+func init() {
+	RootCmd.AddCommand(completionCmd)
+}
+
+var completionCmd = &cobra.Command{
+	Use:   "completion [bash|zsh|fish|powershell]",
+	Short: "Generate command line completion script",
+	Long: `To load completions:
+  Bash:
+    $ source <(gopherciser completion bash)
+
+    # To load completions for each session, execute once:
+    Linux:
+      $ gopherciser completion bash > /etc/bash_completion.d/gopherciser
+    MacOS:
+      $ gopherciser_osx completion bash > /usr/local/etc/bash_completion.d/gopherciser_osx
+
+  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:
+    $ gopherciser completion zsh > "${fpath[1]}/_gopherciser"
+
+    # You might want to put the completion script (_gopherciser) at another
+    # path within the fpath. To view the fpath, execute:
+    $ echo $fpath
+
+    # You will need to start a new shell for this setup to take effect.
+
+  Fish:
+    $ gopherciser completion fish | source
+
+    # To load completions for each session, execute once:
+    $ gopherciser completion fish > ~/.config/fish/completions/gopherciser.fish
+
+  Powershell:
+    PS> gopherciser.exe completion powershell | Out-String | Invoke-Expression
+
+    # To load completions for every new session, run:
+    PS> gopherciser completion powershell > gopherciser.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) {
+		var err error
+		switch args[0] {
+		case "bash":
+			err = cmd.Root().GenBashCompletion(os.Stdout)
+		case "zsh":
+			err = cmd.Root().GenZshCompletion(os.Stdout)
+		case "fish":
+			err = cmd.Root().GenFishCompletion(os.Stdout, true)
+		case "powershell":
+			err = cmd.Root().GenPowerShellCompletion(os.Stdout)
+		}
+		if err != nil {
+			fmt.Fprintln(os.Stderr, err)
+			os.Exit(1)
+		}
+	},
+}

cmd/execute.go

@@ -96,8 +96,8 @@ func (err SummaryTypeError) Error() string {
 var executeCmd = &cobra.Command{
 	Use:     "execute",
 	Aliases: []string{"x"},
-	Short:   "execute exerciser scenario towards a sense installation",
-	Long:    `execute exerciser scenario towards a sense installation`,
+	Short:   "Execute gopherciser scenario towards a sense environment",
+	Long:    `Execute gopherciser scenario towards a sense environment.`,
 	Run: func(cmd *cobra.Command, args []string) {
 		defer func() {
 			var panicErr error = nil

docs/README.md

@@ -36,11 +36,18 @@ Commands:
 * `objdef` (or `od`): Export and validate object definitions files.
 * `script` (or `s`): Execute script command.
 * `version` (or `ver`): Show the version information.
+* `completion` : Generate command line completion script.
 
 Flags:
 
 * `-h`, `--help`: Show the help for a command (`gopherciser [command] --help`).
 
+#### Completion command
+`gopherciser completion [bash|zsh|fish|powershell]`
+
+Run `gopherciser completion --help` and follow the instructions to install command line completion for your shell.
+
+
 #### Execute command
 
 `gopherciser execute [flags]`