CMDR 文档

# 快速起步

# 安装

go get -v github.com/hedzr/cmdr

无论你有否使用 Go Modules，上述命令都能够有效地安装 cmdr 到你的项目中，请在你的项目的根目录中执行该命令。

当前，cmdr 兼容于 go 1.11 及其以上的版本。理论上我们可以兼容更低的 Golang 版本而无需任何修改，然而请注意更低的版本并未获得更多的测试。

要查看 cmdr 的 golang 版本兼容性矩阵，请直达 go.yml (opens new window)。

# 基本用法

这里有一个极简单的应用程序：

package main

import (
	"fmt"
	"github.com/hedzr/cmdr"
	cmdrexamples "github.com/hedzr/cmdr-examples"
	"github.com/hedzr/cmdr/tool"
	"github.com/hedzr/log"
)

func main() {
	if err := cmdr.Exec(buildRootCmd(),
		cmdr.WithLogx(log.NewStdLogger()),
	); err != nil {
		cmdr.Logger.Printf("error: %+v\n", err)
	}
}

func buildRootCmd() (rootCmd *cmdr.RootCommand) {
	root := cmdr.
		Root(appName, cmdrexamples.Version).
		Copyright(copyright, "hedzr").
		Description(desc, longDesc).
		Examples(examples)
	rootCmd = root.RootCommand()
	soundex(root)
	return
}

func soundex(root cmdr.OptCmd) {
	root.NewSubCommand("soundex", "snd", "sndx", "sound").
		Description("soundex test").
		Group("Test").
		TailPlaceholder("[text1, text2, ...]").
		Action(func(cmd *cmdr.Command, args []string) (err error) {
			for ix, s := range args {
				fmt.Printf("%5d. %s => %s\n", ix, s, tool.Soundex(s))
			}
			return
		})
}

const (
	appName   = "getting-start"
	copyright = "getting-start is an effective devops tool"
	desc      = "getting-start is an effective devops tool. It make an demo application for `cmdr`."
	longDesc  = "getting-start is an effective devops tool. It make an demo application for `cmdr`."
	examples  = `
$ {{.AppName}} gen shell [--bash|--zsh|--auto]
  generate bash/shell completion scripts
$ {{.AppName}} gen man
  generate linux man page 1
$ {{.AppName}} --help
  show help screen.
`
)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

其完成的源码可以在 https://github.com/hedzr/cmdr-examples/blob/master/examples/getting-start (opens new window) 中找到。

# 显示帮助屏

运行上面的程序以显示自动生成的帮助屏：

go run ./examples/getting-start
1

结果应该和下图基本上无差别：

image-20200713140513668

# 运行一个子命令

现在我们可以试试运行子命令 soundex 了：

$ go run ./examples/getting-start sndx fish bird
    0. fish => f12
    1. bird => b163
1
2
3

# 搞定了

上面走过，就可以知道 cmdr 能够干点什么了。

🔚

← 概览 (Overview) →