CMDR 文档

CMDR 文档,开发指南,示例等

快速上手 →

简洁至上

采用简单的流式调用方式进行命令行参数定义,便于组织和管理。

符合标准

完全符合 POSIX 命令行界面兼容性标准。

宽泛兼容

你可以非常简单地从 `flag` 代码直接迁移到 `cmdr 方案,几乎无需任何修改。

强力的参数管理

内置 `Option Store` 管理应用程序的一切参数,层级化它们的逻辑结构。

有用的调试信息

使用命令行参数 `~~tree`, `~~debug` 打印完整的命令表。

多种拦截点

在多个关键节点处都可以埋入回调函数从而定制 cmdr 的相关行为

# 立即使用 cmdr (opens new window)

package main

import (
	"fmt"
	"github.com/hedzr/cmdr"
)

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

func buildRootCmd() (rootCmd *cmdr.RootCommand) {
	root := cmdr.
		Root("test-app", "1.1").
		Copyright("test-app is powered by cmdr", "hedzr").
		Description("desc", "longDesc").
		Examples("examples")
		//.Action(func(cmd *cmdr.Command, args []string) (err error) { return; )
	rootCmd = root.RootCommand()
  
	cmdr.NewBool(false).
		Titles("enable-ueh", "ueh").
		EnvKeys("ENABLE_UEH").
		Description("Enables the unhandled exception handler?").
		AttachTo(root)

	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, cmdr.Soundex(s))
			}
			return
		})
	return
}
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

就是如此清晰。