Search code examples
shellgocommand-line-interfacego-cobra

How to provide go bin with commands


I use the following code to create command which should run according to some flags that are passed from the cli.

I use the cobra repo https://github.com/spf13/cobra

when I run it with go run main.go echo test

I get

Print: test

which works.

Now I run go install open the bin directory and click on the file newApp (this my name of my app)

and it prints

Usage:
  MZR [command]

Available Commands:
  echo        Echo anything to the screen
  help        Help about any command
  print       Print anything to the screen

Flags:
  -h, --help   help for MZR

Use "MZR [command] --help" for more information about a command.


[Process completed]

And I cannot use any commands (like MZR echo) which I was able when I run it locally with go run main.go echo test

But I want to use it like following MZR -h or MZR echo , How I can do it ? (and also give to my friend the file from the bin that created after go install - which is Unix executable - 3.8 MB )

e.g. like this repo which use the same command line tools and to run it you use hoarder --server https://github.com/nanopack/hoarder

This is the code for example (to make it more simpler )

package main

import (
    "fmt"
    "strings"

    "github.com/spf13/cobra"
)

func main() {
    var echoTimes int

    var cmdPrint = &cobra.Command{
        Use:   "print [string to print]",
        Short: "Print anything to the screen",
        Long: `print is for printing anything back to the screen.
For many years people have printed back to the screen.`,
        Args: cobra.MinimumNArgs(1),
        Run: func(cmd *cobra.Command, args []string) {
            fmt.Println("Print: " + strings.Join(args, " "))
        },
    }

    var cmdEcho = &cobra.Command{
        Use:   "echo [string to echo]",
        Short: "Echo anything to the screen",
        Long: `echo is for echoing anything back.
Echo works a lot like print, except it has a child command.`,
        Args: cobra.MinimumNArgs(1),
        Run: func(cmd *cobra.Command, args []string) {
            fmt.Println("Print: " + strings.Join(args, " "))
        },
    }

    var cmdTimes = &cobra.Command{
        Use:   "times [# times] [string to echo]",
        Short: "Echo anything to the screen more times",
        Long: `echo things multiple times back to the user by providing
a count and a string.`,
        Args: cobra.MinimumNArgs(1),
        Run: func(cmd *cobra.Command, args []string) {
            for i := 0; i < echoTimes; i++ {
                fmt.Println("Echo: " + strings.Join(args, " "))
            }
        },
    }

    cmdTimes.Flags().IntVarP(&echoTimes, "times", "t", 1, "times to echo the input")

    var rootCmd = &cobra.Command{Use: "MZR"}
    rootCmd.AddCommand(cmdPrint, cmdEcho)
    cmdEcho.AddCommand(cmdTimes)
    rootCmd.Execute()
}

Solution

  • The name of the executable is taken from the directory name. Rename the directory newApp to MZR. With this change, the go install command will create a executable with the name MZR. If the executable is on your path, then you can run it from the command line using MZR -h or MZR echo,