golang命令行生成库cobra

0. 前言

Cobra(眼镜蛇)是一个库，其提供简单的接口来创建强大现代的CLI接口，类似于git或者go工具。同时，它也是一个应用，用来生成个人应用框架，从而开发以Cobra为基础的应用。Docker源码中使用了Cobra。

Cobra基于三个基本概念commands,arguments和flags。其中commands代表行为，arguments代表数值，flags代表对行为的改变。

基本模型如下：

APPNAME COMMAND ARG --FLAG

# hugo是cmmands server是commands，port是flag
hugo server --port=1313

# clone是commands，URL是arguments，brae是flags
git clone URL --bare

1. 安装和使用

安装:

1	go get -u github.com/spf13/cobra/cobra

你的项目结构可能如下:

▾ appName/
  ▾ cmd/
      root.go
      version.go
      commands.go
    main.go

1.1 main.go

In a Cobra app, typically the main.go file is very bare(裸露). It serves one purpose: initializing Cobra.

package main

import (
  "appName/cmd"
)

func main() {
  cmd.Execute()
}

1.2 rootcmd

var rootCmd = &cobra.Command{
  Use:   "hugo",
  Short: "Hugo is a very fast static site generator",
  Long: `A Fast and Flexible Static Site Generator built with
                love by spf13 and friends in Go.
                Complete documentation is available at http://hugo.spf13.com`,
  Run: func(cmd *cobra.Command, args []string) {
    // Do Stuff Here
  },
}

func Execute() {
  if err := rootCmd.Execute(); err != nil {
    fmt.Println(err)
    os.Exit(1)
  }
}

1.3 additional commands

package cmd

import (
  "fmt"

  "github.com/spf13/cobra"
)

func init() {
  rootCmd.AddCommand(versionCmd)
}

var versionCmd = &cobra.Command{
  Use:   "version",
  Short: "Print the version number of Hugo",
  Long:  `All software has versions. This is Hugo's`,
  Run: func(cmd *cobra.Command, args []string) {
    fmt.Println("Hugo Static Site Generator v0.9 -- HEAD")
  },
}

可以简单执行下面命令查看效果

1 2	go run main.go help go run main.go version

3. cobra 生成器

在文件夹github.com/spf13/cobra/cobra下使用go install, 生成 cobra命令

命令cobra init [yourApp]将会创建初始化应用，yourApp 是你的项目名称。它会在你的 GOPATH 目录下面生成项目。最新的操作方式:

1 2	cd /Users/liuwei/golang/src/github.com/unix2dos/golangTest cobra init --pkg-name=github.com/unix2dos/golangTest yourApp

接下来我们用cobra add来添加一些子命令。在你项目的目录下，运行下面这些命令：

1
2
3

cobra add serve
cobra add config
cobra add create -p 'configCmd'

这样以后，你就可以运行上面那些 app serve 之类的命令了。项目目录如下：

▾ app/
  ▾ cmd/
      serve.go
      config.go
      create.go
    main.go

4. 使用Flags

cobra 有两种 flag，一个是全局变量，一个是局部变量。全局什么意思呢，就是所以子命令都可以用。局部的只有自己能用。先看全局的：

1	RootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.cobra_exp1.yaml)")

在看局部的：

1	RootCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")

区别就在 RootCmd 后面的是 Flags 还是 PersistentFlags。

Levon's Blog