Cli

Overview

• Cli is a simple, fast, and fun package for building command line apps in Go. The goal is to enable developers to write fast and distributable command line applications in an expressive way.

Installing

go get github.com/urfave/cli/v2

Start

• 首先新建一个文件夹 great，初始化模块

mkdir great
cd hello
go mo init great

• 然后新建一个文件 great.go，包含以下代码。

package main

import (
	"fmt"
	"github.com/urfave/cli/v2"
	"log"
	"os"
	"sort"
	"strconv"
)

func main() {
	app := &cli.App{
		Flags: []cli.Flag{
			&cli.StringFlag{
				Name:    "lang",
				Aliases: []string{"l"},
				Value:   "english",
				Usage:   "Language for the greeting",
                Required： true,
			},
			&cli.StringFlag{
				Name:    "config",
				Aliases: []string{"c"},
				Usage:   "Load configuration from `FILE`",
			},
		},
		Commands: []*cli.Command{
			{
				Name:    "complete",
				Aliases: []string{"c"},
				Usage:   "complete a task on the list",
				Action: func(*cli.Context) error {
					fmt.Println("complete callback")
					return nil
				},
			},
			{
				Name:    "add",
				Aliases: []string{"a"},
				Usage:   "add a task to the list",
				Action: func(cCtx *cli.Context) error {
					fmt.Println("add callback")
					sum := 0
					for i := 0; i < cCtx.NArg(); i++ {
						temp, err := strconv.Atoi(cCtx.Args().Get(i))
						if err != nil {
							fmt.Printf("第%d个参数非法\n", i+1)
						} else {
							sum += temp
						}
					}
					fmt.Println(sum)
					return nil
				},
			},
		},
		Action: func(cCtx *cli.Context) error {
			name := "Nefertiti"
			if cCtx.NArg() > 0 {
				name = cCtx.Args().Get(0)
			}
			if cCtx.String("lang") == "spanish" {
				fmt.Println("Hola", name)
			} else {
				fmt.Println("Hello", name)
			}
			return nil
		},
	}

	sort.Sort(cli.FlagsByName(app.Flags)) // 将flag按照字母顺序排序，否则按定义的顺序排序
	sort.Sort(cli.CommandsByName(app.Commands))

	if err := app.Run(os.Args); err != nil {
		log.Fatal(err)
	}
}

Args and Flags

• 在上述代码中，定义了两个 flag，用 --lang、--config 进行调用，或者用简写 -l、-c

• 定义了两个 command，用 complete、add 或者简写 c、a 进行调用

• NArgs() 返回命令行参数的个数

• Args().Get(i) 用来获取命令行中的第 i+1 个参数

• 通过 go install 可以将你的命令集成到系统中

go install
great add 1 2 asd 3 4
// add callback
// 第3个参数非法
// 10

great -l spanish 谷安
// hola 谷安

• 如果要求用户必须提供所需的标志，则可以将 Required 字段置为 true。如果用户没有提供相应的标志，则会提示用户 Required flag "lang" not set

• 可以通过 DefaultText 字段指定默认值

• 标志位的优先级（从高到低）

  • 来自用户的命令行标志值
  • 环境变量（如果已指定）
  • 配置文件（如果已指定）
  • 标志上定义的默认值

Subcommands

• 用户可以给已有的命令添加子命令
• 添加子命令的方法也很简单，直接在父命令的结构体中增加 Subcommands 字段，Subcommands 字段也是一个结构体。子命令跟父命令是同一种结构体，简单理解为套娃。

package main

import (
	"fmt"
	"log"
	"os"

	"github.com/urfave/cli/v2"
)

func main() {
	app := &cli.App{
		Commands: []*cli.Command{
			{
				Name:    "add",
				Aliases: []string{"a"},
				Usage:   "add a task to the list",
				Action: func(cCtx *cli.Context) error {
					fmt.Println("added task: ", cCtx.Args().First())
					return nil
				},
			},
			{
				Name:    "complete",
				Aliases: []string{"c"},
				Usage:   "complete a task on the list",
				Action: func(cCtx *cli.Context) error {
					fmt.Println("completed task: ", cCtx.Args().First())
					return nil
				},
			},
			{
				Name:    "template",
				Aliases: []string{"t"},
				Usage:   "options for task templates",
				Action: func(cCtx *cli.Context) error {
					fmt.Println("template task: ", cCtx.Args().First())
					return nil
				},
				Subcommands: []*cli.Command{
					{
						Name:    "add",
						Usage:   "add a new template",
						Aliases: []string{"a"},
						Action: func(cCtx *cli.Context) error {
							fmt.Println("new task template: ", cCtx.Args().First())
							return nil
						},
					},
					{
						Name:    "remove",
						Usage:   "remove an existing template",
						Aliases: []string{"r"},
						Action: func(cCtx *cli.Context) error {
							fmt.Println("removed task template: ", cCtx.Args().First())
							return nil
						},
					},
				},
			},
		},
	}

	if err := app.Run(os.Args); err != nil {
		log.Fatal(err)
	}
}

Add Flags for Commands

• 给已有命令添加标志。在结构体中增加 Flag 字段，Flag 也是一个结构体。

package main

import (
	"fmt"
	"log"
	"os"

	"github.com/urfave/cli/v2"
)

func main() {
	app := &cli.App{
		UseShortOptionHandling: true,
		Commands: []*cli.Command{
			{
				Name:    "short",
				Usage:   "complete a task on the list",
				Aliases: []string{"s"},
				Flags: []cli.Flag{
					&cli.BoolFlag{Name: "serve", Aliases: []string{"s"}},
					&cli.BoolFlag{Name: "option", Aliases: []string{"o"}},
					&cli.StringFlag{Name: "message", Aliases: []string{"m"}},
					&cli.StringFlag{Name: "emm", Aliases: []string{"e"}},
				},
				Action: func(cCtx *cli.Context) error {
					fmt.Println("serve:", cCtx.Bool("serve"))
					fmt.Println("option:", cCtx.Bool("option"))
					fmt.Println("message:", cCtx.String("message"))
					fmt.Println("emm:", cCtx.String("emm"))
					return nil
				},
			},
		},
	}

	if err := app.Run(os.Args); err != nil {
		log.Fatal(err)
	}
}

• 下面几种调用方式。主要说一下后面两种。在有多个 Bool 类型的标志位时，可以同一个非 Bool 类型的标志位一起使用，即共有一个 -。若有多个非 Bool 类型的标志位，则剩余的非 Bool 类型标志位按常规方式使用。

未完待续。。。

赏

谢谢你请我喝奶茶

支付宝

微信

• 本文作者： 谷安
• 本文链接： http://example.com/2022/07/23/Cli/
• 版权声明： 转载请注明出处