[cobra]-强大的CLI应用程序库

happlyfox 等级 376 0 0

关于我

我的博客|文章首发

cobra介绍

[cobra]-强大的CLI应用程序库

Cobra是一个用于创建强大的现代CLI应用程序的库,也是一个用于生成应用程序和命令文件的程序。

Cobra用于许多Go项目,如KubernetesHugoGithub CLI等。此列表包含了使用Cobra的更广泛的项目列表。

概述

Cobra是一个库,提供了一个简单的界面来创建功能强大的现代CLI界面,类似于git&go工具。

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

眼镜蛇提供:

  • 简单易用的基于子的CLI:app serverapp fetch等。
  • 完全兼容POSIX的标志(包括短版和长版)
  • 嵌套子命令
  • 全局,局部和级联标志
  • 易产生的应用程序和命令与cobra init appnamecobra 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使用

目录结构

[cobra]-强大的CLI应用程序库

基命令

创建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

推荐阅读

Redis工具收费后新的开源已出现

GitHub上Star最高的工程师技能图谱

中国程序员最容易发错的单词

推荐!!! Markdown图标索引网站

END

欢迎关注公众号 程序员工具集 👍👍 致力于分享优秀的开源项目、学习资源 、常用工具

回复关键词“关注礼包”,送你一份最全的程序员技能图谱。

回复关键词"wx"添加个人微信,勾搭作者,欢迎来聊^-^。

收藏
评论区

相关推荐

Golang高并发抓取HTML图片
版权所有,转载请注明:http://www.lenggirl.com/language/gopicture.html(https://links.jianshu.com/go?tohttp%3A%2F%2Fwww.lenggirl.com%2Flanguage%2Fgopicture.html) 使用准备 1.安装Golang 2.
【Golang】Golang + jwt 实现简易用户认证
<p本文已同步发布到我的个人博客:<a href"https://links.jianshu.com/go?tohttps%3A%2F%2Fglorin.xyz%2F2019%2F11%2F23%2FGolangjwtsimpleauth%2F" target"_blank"https://glorin.xyz/2019/11/23/Golang
golang 中神奇的 slice
声明:本文仅限于简书发布,其他第三方网站均为盗版,原文地址: golang 中神奇的 slice(https://links.jianshu.com/go?tohttps%3A%2F%2Fliqiang.io%2Fpost%2Fimagesliceingolang) 在 golang 中,似乎人们都不太喜欢使用 Linked List,甚至于原
godoc 命令和 golang 代码文档管理
介绍 godoc 是 golang 自带的文档查看器,更多的提供部署服务 go doc 和 godoc 在 golang 1.13 被移除了,可以自行安装 golang.org go1.13 godoc(https://links.jianshu.com/go?tohttps%3A%2F%2Fgolang.org%2Fdoc%2Fg
Mac安装Golang和vscode
Mac第一次安装golang和vscode一起使用,遇到了不少的坑,下面介绍一下正确的安装方式。 1、使用brew安装Golang 如果不知道brew是什么,或怎么安装请看这里 brew官网(https://brew.sh/index_zhcn) brew install golang 安装完成后可以使用
vue.config.js配置前端代理
// vue.config.js 配置说明 //官方vue.config.js 参考文档 https://cli.vuejs.org/zh/config/cssloaderoptions // 这里只列一部分,具体配置参考文档 module.exports { // 部署生产环境和开发环境下的URL。 // 默认情况下,Vue CLI
Vue2全家桶之一:vue-cli(vue脚手架)超详细教程
这是我第4篇简书。   都说Vue2简单上手容易,的确,看了官方文档确实觉得上手很快,除了ES6语法和webpack的配置让你感到陌生,重要的是思路的变换,以前用jq随便拿全局变量和修改dom的锤子不能用了,vue只用关心数据本身,不用再频繁繁琐的操作dom,注册事件、监听事件、取消事件。。。。(确实很烦)。vue的官方文档还是不错的,由浅到深,如果不使用
深入理解 Go Slice
(https://imghelloworld.osscnbeijing.aliyuncs.com/0ce8a8773a658d4b843e5796a0dbf001.png) image 原文地址:深入理解 Go Slice(https://github.com/EDDYCJY/blog/blob/master/golang/pkg/20
golang包循环引用的几种解决方案
golang包循环引用的几种解决方案 发表于2020年11月2日2020年11月3日(https://libuba.com/2020/11/02/golang%e5%8c%85%e5%be%aa%e7%8e%af%e5%bc%95%e7%94%a8%e7%9a%84%e5%87%a0%e7%a7%8d%e8%a7%
[译]尤雨溪: Vite 会取代 vue-cli 吗?
前言 最近在逛 Twitter 时,突发奇想去看了一眼尤大的账号,发现了一段有趣的推文,在尤大国内的社交平台账号中(_知乎、微博等_)并没有发现他发表过类似的话,倒是听过他说会有越来越多的人弃坑 Webpack 用 Vite,还听过有人说 vuecli 的下一个版本就要用 vite 重构了,不过看尤雨溪这说法,好像是 vite 是 vite,cli
[cobra]-强大的CLI应用程序库
关于我 cobra介绍<img src"https://gitee.com/happlyfox/img/raw/master/image20210218091620719.png" alt"title.img" style"zoom:80%;" /Cobra是一个用于创建强大的现代CLI应用程序的库,也是一个用于生成应用程序和命令文件的程序
GO开发[一]:golang语言初探
一.Golang的安装 1.https://dl.gocn.io/ (国内下载地址) (https://imghelloworld.osscnbeijing.aliyuncs.com/658c5d13c377
go get下载包失败问题
关于我由于某些不可抗力的原因,国内使用go get命令安装包时会经常会出现timeout的问题。本文介绍几个常用的解决办法。 从github克隆golang在github上建立了一个镜像库,如https://github.com/golang/net就对应是 https://golang.org/x/net的镜像库。 要下载golang.org/x/net包
如何在React Native和Expo中掩盖Text和TextInput组件
在本文中,我将向您展示如何在React Native和Expo中使用自定义蒙版,可用于iOS,Android和Web!我们将使用一个名为库,这是一个没有本机代码的完整javascript库,然后您可以在React Native环境的所有CLI中使用。](https://res.cloudinary.com/practicaldev/image/fetch/s
https://cloud.tencent.com/developer/article/write/1830331
一、目标今天的目标是这个sign和appcode 二、步骤 Jadx没法上了app加了某梆的企业版,Jadx表示无能为力了。 FRIDADEXDumpDexDump出来,木有找到有效的信息。 Wallbreaker葫芦娃的Wallbreaker可以做些带壳分析,不过这个样本,用Frida的Spawn模式可以载入,Attach模式会失败。而直接用Objecti