热门标签 | HotTags
当前位置:  开发笔记 > 编程语言 > 正文

玩转Go命令行工具Cobra

这篇文章主要介绍了玩转Go命令行工具Cobra,本文介绍了Cobra的最基本也是最常用的使用部分,但是Cobra仍然有很多优秀的操作值得我们学习,需要的朋友可以参考下

不知大家有没有在使用Git命令、Linux的yum命令、Go命令、Maven命令的时候感觉到非常的酷,比如你刚刚拿到一个Go的开源项目,初始化时只需要输入go mod tidy进行对依赖的下载,或者是git clone xxx之后拉下来一个GitHub上的项目,mvn package或者go build就可以将整合项目打包成一个可执行的文件,当然这些操作现在大多数都能通过可视化的UI界面进行,但是就少了一些韵味,还是使用原生的CLI工具最能体现程序执行的过程,并且真是的生产环境中大多数也只能通过这种命令的方式来进行,因此我们就有必要搞一下这个大蟒蛇工具——Cobra。

1 简介

在这里插入图片描述

GitHub:https://github.com/spf13/cobra

Cobra是一个用于创建强大的现代CLI应用程序的库。在很多围棋项目中使用,比如Kubernetes, Hugo和GitHub CLI等等。

那么什么是CLI呢,简单来讲就是命令行工具界面,Command Line Interface for batch scripting的简称,在我们开发中广泛的使用,比如你打开Git Bash,输入git clone XXX,这个就是操作Git的命令行工具界面。

除此之外,Cobra还提供:

  • 简单的基于子命令的cli:应用服务器,应用获取,等等。
  • 完全兼容posix的标志(包括短版本和长版本)
  • 嵌套的子命令
  • 全局、本地和级联标志
  • 命令和标志的自动帮助生成
  • 自动识别-h、——help等帮助标志。
  • 为您的应用程序自动生成shell自动完成(bash, zsh, fish, powershell)
  • 为您的应用程序自动生成的手册页
  • 命令别名,以便您可以更改而不破坏它们
  • 定义自己的帮助、用法等的灵活性。

什么是命令&参数&标识符?

Cobra 是构建在命令、参数和标识符之上的:

  • Commands 表示执行动作
  • Args 就是执行参数
  • Flags 是这些动作的标识符

基本的执行命令如下所示:

$ APPNAME Command Args --Flags 
# 或者
$ APPNAME Command --Flags Args

2 安装

2.1 安装Cobra-cli脚手架工具

go install github.com/spf13/cobra-cli@latest

下载完成之后会在我们的$GOPATH目录的bin目录下生成一个二进制的文件cobra-cli.exe(Windows下)或cobra-cli(LInux下),如果出现问题,如:

在这里插入图片描述

我们可以直接找到$GO_PATH\pkg\mod\github.com\spf13\cobra-cli@v1.3.0目录,直接go build自己编译一个二进制文件。

之后一步,为了方便使用我们可以将生成的二进制文件放在环境变量里,让他在任何地方都能使用,步骤过于简单就忽略了哈。

2.2 在项目中下载Cobra依赖

go get -u github.com/spf13/cobra@latest

3 使用方式

其实在使用方式这一块有两种方法,一种是自己直接写代码,另一种就是使用刚刚我们安装的cobra-cli来生成脚手架代码,我们就在Hello World里面将cobra-cli生成代码试一遍。

3.1 Hello World

首先在项目根目录下打开终端(必须是Go Module项目),然后输入命令cobra-cli init就会在项目中生成如下代码:

在这里插入图片描述

我们看下具体的代码:

main.go

package main

import "go-cobra/cmd"

func main() {
   cmd.Execute()
}

root.go

package cmd

import (
   "os"

   "github.com/spf13/cobra"
)

// rootCmd represents the base command when called without any subcommands
var rootCmd = &cobra.Command{
   Use:   "go-cobra",
   Short: "A brief description of your application",
   Long: `A longer description that spans multiple lines and likely contains
examples and usage of using your application. For example:

Cobra is a CLI library for Go that empowers applications.
This application is a tool to generate the needed files
to quickly create a Cobra application.`,
   // Uncomment the following line if your bare application
   // has an action associated with it:
   // Run: func(cmd *cobra.Command, args []string) { },
}

// Execute adds all child commands to the root command and sets flags appropriately.
// This is called by main.main(). It only needs to happen once to the rootCmd.
func Execute() {
   err := rootCmd.Execute()
   if err != nil {
      os.Exit(1)
   }
}

func init() {
   // Here you will define your flags and configuration settings.
   // Cobra supports persistent flags, which, if defined here,
   // will be global for your application.

   // rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.go-cobra.yaml)")

   // Cobra also supports local flags, which will only run
   // when this action is called directly.
   rootCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
}

我们将root.go里面的代码进行部分修改:

package cmd

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

var name string

var rootCmd = &cobra.Command{
   Use: "hello",
   Run: func(cmd *cobra.Command, args []string) {
      fmt.Println("hello ", name)
   },
}

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

func init() {
   rootCmd.Flags().StringVarP(&name, "name", "", "world", "")
}

测试:

$ go build

$ .\go-cobra.exe --name zs
hello  zs

$ .\go-cobra.exe
hello  world

3.2 开发自己的Cli命令

使用cobra-cli脚手架,或者也可以自己手写如下代码

cobra-cli add hi

这个时候我们就会发现多了一个文件,当然也可以自己手写代码:

在这里插入图片描述

在hi.go文件中代码:

package cmd

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

var (
   age     int
   like    []string
   address string
)

var hiCmd = &cobra.Command{
   Use:   "hi",
   Short: "",
   Long:  "",
   Run: func(cmd *cobra.Command, args []string) {
      Print()
   },
}

func init() {
   rootCmd.AddCommand(hiCmd)
   hiCmd.Flags().StringVarP(&name, "name", "", "world", "")
   hiCmd.Flags().IntVarP(&age, "age", "", 1, "")
   hiCmd.Flags().StringSliceVarP(&like, "like", "", []string{}, "")
   hiCmd.Flags().StringVarP(&address, "address", "", "Beijing", "")
}

func Print() {
   fmt.Println("name:", name)
   fmt.Println("age:", age)
   fmt.Println("like:", like)
   fmt.Println("address:", address)
}

测试:

.\go-cobra.exe hi --name zs --age 100 --like Coding,Running --address ShangHai
name: zs
age: 100
like: [Coding Running]
address: ShangHai

3.3 规则和扩展使用

3.3.1 我们不难看出规则

新增命令就是自定义&cobra.Command

新增标识符就是命令.Flags().xxx

新增的命令都需要在rootCmd中添加,新增的标识符都要在init中添加

3.3.2 小扩展

一些常用到的方法:

  • NoArgs:如果有任何参数,命令行将会报错
  • ArbitraryArgs: 命令行将会接收任何参数
  • OnlyValidArgs: 如果有如何参数不属于 Command 的 ValidArgs 字段,命令行将会报错
  • MinimumNArgs(int): 如果参数个数少于 N 个,命令行将会报错
  • MaximumNArgs(int): 如果参数个数多于 N 个,命令行将会报错
  • ExactArgs(int): 如果参数个数不等于 N 个,命令行将会报错
  • RangeArgs(min, max): 如果参数个数不在 min 和 max 之间, 命令行将会报错

3.3.3 自定义帮助命令

...
var hiCmd = &cobra.Command{
   Use:   "hi",
   Short: "sss",
   Long:  "lll",
   Run: func(cmd *cobra.Command, args []string) {
      if len(args) == 0 {
         cmd.Help()
         return
      }
      Print()
   },
}
...

测试:

$ .\go-cobra.exe hi                                                             
Usage:
  hello hi [flags]


Usage:
  hello hi [flags]

Flags:
      --address string    (default "Beijing")
      --age int           (default 1)
  -h, --help             help for hi
      --like strings
      --name string       (default "world")

4 小总结

本文介绍了Cobra的最基本也是最常用的使用部分,但是Cobra仍然有很多优秀的操作值得我们学习。拜拜喽~

到此这篇关于玩转Go命令行工具Cobra的文章就介绍到这了,更多相关Go命令行工具Cobra内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持!


推荐阅读
  • imx6ull开发板驱动MT7601U无线网卡的方法和步骤详解
    本文详细介绍了在imx6ull开发板上驱动MT7601U无线网卡的方法和步骤。首先介绍了开发环境和硬件平台,然后说明了MT7601U驱动已经集成在linux内核的linux-4.x.x/drivers/net/wireless/mediatek/mt7601u文件中。接着介绍了移植mt7601u驱动的过程,包括编译内核和配置设备驱动。最后,列举了关键词和相关信息供读者参考。 ... [详细]
  • CentOS7.8下编译muduo库找不到Boost库报错的解决方法
    本文介绍了在CentOS7.8下编译muduo库时出现找不到Boost库报错的问题,并提供了解决方法。文章详细介绍了从Github上下载muduo和muduo-tutorial源代码的步骤,并指导如何编译muduo库。最后,作者提供了陈硕老师的Github链接和muduo库的简介。 ... [详细]
  • 在Docker中,将主机目录挂载到容器中作为volume使用时,常常会遇到文件权限问题。这是因为容器内外的UID不同所导致的。本文介绍了解决这个问题的方法,包括使用gosu和suexec工具以及在Dockerfile中配置volume的权限。通过这些方法,可以避免在使用Docker时出现无写权限的情况。 ... [详细]
  • 本文介绍了Linux Shell中括号和整数扩展的使用方法,包括命令组、命令替换、初始化数组以及算术表达式和逻辑判断的相关内容。括号中的命令将会在新开的子shell中顺序执行,括号中的变量不能被脚本余下的部分使用。命令替换可以用于将命令的标准输出作为另一个命令的输入。括号中的运算符和表达式符合C语言运算规则,可以用在整数扩展中进行算术计算和逻辑判断。 ... [详细]
  • Go Cobra命令行工具入门教程
    本文介绍了Go语言实现的命令行工具Cobra的基本概念、安装方法和入门实践。Cobra被广泛应用于各种项目中,如Kubernetes、Hugo和Github CLI等。通过使用Cobra,我们可以快速创建命令行工具,适用于写测试脚本和各种服务的Admin CLI。文章还通过一个简单的demo演示了Cobra的使用方法。 ... [详细]
  • 本文介绍了使用readlink命令获取文件的完整路径的简单方法,并提供了一个示例命令来打印文件的完整路径。共有28种解决方案可供选择。 ... [详细]
  • Centos7.6安装Gitlab教程及注意事项
    本文介绍了在Centos7.6系统下安装Gitlab的详细教程,并提供了一些注意事项。教程包括查看系统版本、安装必要的软件包、配置防火墙等步骤。同时,还强调了使用阿里云服务器时的特殊配置需求,以及建议至少4GB的可用RAM来运行GitLab。 ... [详细]
  • baresip android编译、运行教程1语音通话
    本文介绍了如何在安卓平台上编译和运行baresip android,包括下载相关的sdk和ndk,修改ndk路径和输出目录,以及创建一个c++的安卓工程并将目录考到cpp下。详细步骤可参考给出的链接和文档。 ... [详细]
  • Linux磁盘的分区、格式化的观察和操作步骤
    本文介绍了如何观察Linux磁盘的分区状态,使用lsblk命令列出系统上的所有磁盘列表,并解释了列表中各个字段的含义。同时,还介绍了使用parted命令列出磁盘的分区表类型和分区信息的方法。在进行磁盘分区操作时,根据分区表类型选择使用fdisk或gdisk命令,并提供了具体的分区步骤。通过本文,读者可以了解到Linux磁盘分区和格式化的基本知识和操作步骤。 ... [详细]
  • 本文介绍了Android 7的学习笔记总结,包括最新的移动架构视频、大厂安卓面试真题和项目实战源码讲义。同时还分享了开源的完整内容,并提醒读者在使用FileProvider适配时要注意不同模块的AndroidManfiest.xml中配置的xml文件名必须不同,否则会出现问题。 ... [详细]
  • Android源码深入理解JNI技术的概述和应用
    本文介绍了Android源码中的JNI技术,包括概述和应用。JNI是Java Native Interface的缩写,是一种技术,可以实现Java程序调用Native语言写的函数,以及Native程序调用Java层的函数。在Android平台上,JNI充当了连接Java世界和Native世界的桥梁。本文通过分析Android源码中的相关文件和位置,深入探讨了JNI技术在Android开发中的重要性和应用场景。 ... [详细]
  • Go GUIlxn/walk 学习3.菜单栏和工具栏的具体实现
    本文介绍了使用Go语言的GUI库lxn/walk实现菜单栏和工具栏的具体方法,包括消息窗口的产生、文件放置动作响应和提示框的应用。部分代码来自上一篇博客和lxn/walk官方示例。文章提供了学习GUI开发的实际案例和代码示例。 ... [详细]
  • 本文详细介绍了git常用命令及其操作方法,包括查看、添加、提交、删除、找回等操作,以及如何重置修改文件、抛弃工作区修改、将工作文件提交到本地暂存区、从版本库中删除文件等。同时还介绍了如何从暂存区恢复到工作文件、恢复最近一次提交过的状态,以及如何合并多个操作等。 ... [详细]
  • ps:写的第一个,不足之处,欢迎拍砖---只是想用自己的方法一步步去实现一些框架看似高大上的小功能(比如说模型中的toArraytoJsonsetAtt ... [详细]
  • 本文介绍了在CentOS 6.4系统中更新源地址的方法,包括备份现有源文件、下载163源、修改文件名、更新列表和系统,并提供了相应的命令。 ... [详细]
author-avatar
坤哥小妹
这个家伙很懒,什么也没留下!
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有