乐趣区

关于golang:cobra强大的CLI应用程序库

jiezi

cobra 介绍

Cobra 是一个用于创立弱小的古代 CLI 应用程序的库，也是一个用于生成应用程序和命令文件的程序。

Cobra 用于许多 Go 我的项目，如 Kubernetes、Hugo 和 Github CLI 等。此列表蕴含了应用 Cobra 的更宽泛的我的项目列表。

概述

Cobra 是一个库，提供了一个简略的界面来创立功能强大的古代 CLI 界面，相似于 git&go 工具。

Cobra 还是一个应用程序，它将生成您的应用程序框架以疾速开发基于 Cobra 的应用程序。

眼镜蛇提供：

  • 简略易用的基于子的 CLI：app server，app fetch等。
  • 齐全兼容 POSIX 的标记（包含短版和长版）
  • 嵌套子命令
  • 全局，部分和级联标记
  • 易产生的应用程序和命令与cobra init appname&cobra add cmdname
  • 理智的倡议（app srver……是您的意思 app server 吗？）
  • 主动生成命令和标记的帮忙
  • 主动帮忙标记辨认 -h，--help 等等。
  • 为您的应用程序主动生成的外壳主动实现性能（bash，zsh，fish，powershell）
  • 主动为您的应用程序生成手册页
  • 命令别名，以便您能够更改内容而不会毁坏它们
  • 定义本人的帮忙，用法等的灵活性。
  • 可选与 viper 严密集成，可用于 12 因子应用程序

概念

Cobra 建设在命令，参数和标记的构造上。

命令 代表动作，Args是事物，Flags是这些动作的修饰符。

最好的应用程序在应用时读起来就像句子，后果，用户直观地晓得如何与之交互。

遵循的模式是 APPNAME VERB NOUN --ADJECTIVE. 或 APPNAME COMMAND ARG --FLAG

一些实在的例子能够更好地阐明这一点。

在以下示例中，“服务器”是命令，“端口”是标记：

hugo server --port=1313

在此命令中，咱们通知 Git 克隆 url 的内容。

git clone URL --bare

装置

应用眼镜蛇很容易。首先，应用 go get 来装置该库的最新版本。此命令将装置 cobra 生成器可执行文件以及库及其依赖项：

go get -u github.com/spf13/cobra

Next, include Cobra in your application:

import "github.com/spf13/cobra"

入门

欢迎您提供本人的组织，然而通常基于 Cobra 的应用程序将遵循以下组织构造：

  ▾ appName/
    ▾ cmd/
        add.go
        your.go
        commands.go
        here.go
      main.go

在 Cobra 应用程序中，通常 main.go 文件十分袒露。它有一个目标：初始化眼镜蛇

package main

import ("{pathToYourApp}/cmd"
)

func main() {cmd.Execute()
}

Cobra 应用

目录构造

基命令

创立 root.go 文件，定义一个基命令

package cmd

import ("github.com/spf13/cobra")

var RootCmd = &cobra.Command{
    Use: "gonne",
    Run: func(cmd *cobra.Command, args []string) {if len(args) == 0 {cmd.Help()
            return
        }
    },
}

在 main 函数中应用命令，就是这么简略

main.go文件

package main

import (
    "demo-practice/cobra/cmd"
    "fmt"
    "os"
)

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

在 windows 环境下编译

go build -o gonne.exe

执行命令查看成果，输入内容如下所示

gonne.exe

Usage:
gonne [flags]
gonne [command]

Available Commands:
help Help about any command
version Print the version number of Gonne

Flags:
-h, –help help for gonne

Use “gonne [command] –help” for more information about a command.

子命令

在基命令上减少子命令也相当简略，基本无需在基命令和 main 办法中写任何代码，只需新建一个 go 文件，多个子命令间也是互相独立的，如许优雅的代码，辞别各种 case

减少一个版本命令用法：

在 cmd 目录下减少一个 version.go 文件, 内容如下

package cmd

import "github.com/spf13/cobra"

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

var versionCmd = &cobra.Command{
    Use:   "version",
    Short: "Print the version number of Gonne",
    Run: func(cmd *cobra.Command, args []string) {println("gonne version is 0.0.1")
    },
}

init()函数将此命令增加到基命令下

编译后执行 gonne version

gonne version is 0.0.1

资源列表

https://github.com/spf13/cobra

title: ‘cobra- 弱小的 CLI 利用程序库 ’
date: 2021-02-18 10:08:30
author: 周慧博
summary: Cobra 是一个用于创立弱小的古代 CLI 应用程序的库，也是一个用于生成应用程序和命令文件的程序。Cobra 用于许多 Go 我的项目，如 Kubernetes 和[Github CLI] 等。蕴含了应用 Cobra 的更宽泛的我的项目列表。
categories: golang
tags:

  • cobra

cobra 介绍

Cobra 是一个用于创立弱小的古代 CLI 应用程序的库，也是一个用于生成应用程序和命令文件的程序。

Cobra 用于许多 Go 我的项目，如 Kubernetes、Hugo 和 Github CLI 等。此列表蕴含了应用 Cobra 的更宽泛的我的项目列表。

概述

Cobra 是一个库，提供了一个简略的界面来创立功能强大的古代 CLI 界面，相似于 git&go 工具。

Cobra 还是一个应用程序，它将生成您的应用程序框架以疾速开发基于 Cobra 的应用程序。

眼镜蛇提供：

  • 简略易用的基于子的 CLI：app server，app fetch等。
  • 齐全兼容 POSIX 的标记（包含短版和长版）
  • 嵌套子命令
  • 全局，部分和级联标记
  • 易产生的应用程序和命令与cobra init appname&cobra add cmdname
  • 理智的倡议（app srver……是您的意思 app server 吗？）
  • 主动生成命令和标记的帮忙
  • 主动帮忙标记辨认 -h，--help 等等。
  • 为您的应用程序主动生成的外壳主动实现性能（bash，zsh，fish，powershell）
  • 主动为您的应用程序生成手册页
  • 命令别名，以便您能够更改内容而不会毁坏它们
  • 定义本人的帮忙，用法等的灵活性。
  • 可选与 viper 严密集成，可用于 12 因子应用程序

概念

Cobra 建设在命令，参数和标记的构造上。

命令 代表动作，Args是事物，Flags是这些动作的修饰符。

最好的应用程序在应用时读起来就像句子，后果，用户直观地晓得如何与之交互。

遵循的模式是 APPNAME VERB NOUN --ADJECTIVE. 或 APPNAME COMMAND ARG --FLAG

一些实在的例子能够更好地阐明这一点。

在以下示例中，“服务器”是命令，“端口”是标记：

hugo server –port=1313

在此命令中，咱们通知 Git 克隆 url 的内容。

git clone URL –bare

装置

应用眼镜蛇很容易。首先，应用 go get 来装置该库的最新版本。此命令将装置 cobra 生成器可执行文件以及库及其依赖项：

go get -u github.com/spf13/cobra

Next, include Cobra in your application:

import “github.com/spf13/cobra”

入门

欢迎您提供本人的组织，然而通常基于 Cobra 的应用程序将遵循以下组织构造：

▾ appName/
▾ cmd/
add.go
your.go
commands.go
here.go
main.go

在 Cobra 应用程序中，通常 main.go 文件十分袒露。它有一个目标：初始化眼镜蛇

package main
​
import (
“{pathToYourApp}/cmd”
)
​
func main() {
cmd.Execute()
}

Cobra 应用

目录构造

基命令

创立 root.go 文件，定义一个基命令

package cmd
​
import (
“github.com/spf13/cobra”
)
​
var RootCmd = &cobra.Command{
Use: “gonne”,
Run: func(cmd *cobra.Command, args []string) {
if len(args) == 0 {
cmd.Help()
return
}
},
}

在 main 函数中应用命令，就是这么简略

main.go文件

package main
​
import (
“demo-practice/cobra/cmd”
“fmt”
“os”
)
​
func main() {
if err := cmd.RootCmd.Execute(); err != nil {
fmt.Println(err)
os.Exit(1)
}
}

在 windows 环境下编译

go build -o gonne.exe

执行命令查看成果，输入内容如下所示

gonne.exe

Usage: gonne [flags] gonne [command]

Available Commands: help Help about any command version Print the version number of Gonne

Flags: -h, –help help for gonne

Use “gonne [command] –help” for more information about a command.

子命令

在基命令上减少子命令也相当简略，基本无需在基命令和 main 办法中写任何代码，只需新建一个 go 文件，多个子命令间也是互相独立的，如许优雅的代码，辞别各种 case

减少一个版本命令用法：

在 cmd 目录下减少一个 version.go 文件, 内容如下

package cmd

import “github.com/spf13/cobra”

func init() {

RootCmd.AddCommand(versionCmd)

}

var versionCmd = &cobra.Command{

Use:   "version",
Short: "Print the version number of Gonne",
Run: func(cmd *cobra.Command, args []string) {println("gonne version is 0.0.1")
},

}

init()函数将此命令增加到基命令下

编译后执行 gonne version

gonne version is 0.0.1

资源列表

https://github.com/spf13/cobra

退出移动版