当前位置:首页 > 文章列表 > Golang > Go问答 > 如何将两个 Cobra CLI 合并为一个?

如何将两个 Cobra CLI 合并为一个?

来源:stackoverflow 2024-03-09 18:21:23 0浏览 收藏

一分耕耘,一分收获!既然都打开这篇《如何将两个 Cobra CLI 合并为一个?》,就坚持看下去,学下去吧!本文主要会给大家讲到等等知识点,如果大家对本文有好的建议或者看到有不足之处,非常欢迎大家积极提出!在后续文章我会继续更新Golang相关的内容,希望对大家都有所帮助!

问题内容

我有以下 cli a 命令(请参阅真实存储库):

$ cli-a -h

usage:
  cli-a [command]

available commands:
  command-a1       command description
  command-a2       command description
  command-a3       command description

flags:
      --config string   config file (default is $home/.cli-a.json)
  -h, --help            help for cli-a

use "cli-a [command] --help" for more information about a command.

对于 cli b,我有以下命令(请参阅真实的存储库):

$ cli-b -h

usage:
  cli-b [command]

available commands:
  command-b1       command description
  command-b2       command description
  command-b3       command description

flags:
      --kubeconfig string   path to kubeconfig file
  -h, --help                help for cli-b

use "cli-b [command] --help" for more information about a command.

我现在想做的是,我希望 cli b(及其所有子命令)成为 cli a 的子命令,如下所示:

$ cli-a -h

usage:
  cli-a [command]

available commands:
  command-a1       command description
  command-a2       command description
  command-a3       command description
  cli-b            description about cli-b

flags:
      --config string   config file (default is $home/.cli-a.json)
  -h, --help            help for cli-a

use "cli-a [command] --help" for more information about a command.

因此,当用户运行 $ cli-a cli-b -h 时,他们会看到:

$ cli-a cli-b -h

Usage:
  cli-a cli-b [command]

Available Commands:
  command-b1       command description
  command-b2       command description
  command-b3       command description

Flags:
      --kubeconfig string   path to kubeconfig file
  -h, --help                help for cli-b

Use "cli-a cli-b [command] --help" for more information about a command.

两个存储库都位于不同的 go 模块名称/存储库中。如果用户不喜欢下载和使用 cli a 中的所有功能,我仍然想向他们提供 cli b 供他们下载。

cli b 的大部分工作(功能、错误修复等)将在 cli b 存储库中完成,我正在考虑将它们两个合并到我的 cli a 的 ci 管道中(需要考虑如何做)这也是)。

如果可能的话,我不想每次更改 cli b 代码库(业务逻辑、cli 标志等)时都更改/更新 cli a 代码库中的任何内容。我希望 cli a 就像 cli b 的代理服务器一样(我在这里使用类比) - 所有业务逻辑都保存在 cli b 代码库中。

而且,如果您仔细查看上面的示例输出,当用户运行 $ cli-a cli-b -h$ cli-a cli-b command-bn [-h] 时,我不希望cli a 的根标志 (--config) 出现并生效。相反,我希望 cli b 的根标志 (--kubeconfig) 显示并生效。

问题

  1. 这对于 cobra 可行吗?
  2. 在 cli a 的存储库中不添加太多代码的情况下实现此目标的最佳方法是什么?
  3. 项目结构/树应该是什么样子?
  4. 有什么好的例子可供我参考吗?
  5. 从总体上来说,我应该在 cli a 的构建/ci 管道中做什么才能实现这一点?

我非常感谢这里的所有输入、指针、示例和外部资源。预先感谢您。


正确答案


我已经做了类似的事情,您可以将两个 cli 维护为不同的模块,无需合并代码。

您在 cli-a 的 root 命令中所需要做的就是

cliarootcommand.addcommand(
       clibpackage.newrootcommand(),
)

对于问题的第二部分,clia 的持久标志不是 clib 的一部分。我们在clib中禁用标志解析​​,并在clib根命令的prerune中,我们可以将所有父标志标记为隐藏,然后解析标志。

func NewRootCommand() *cobra.Command {
    rootCommand := &cobra.Command{
        Use: "cli-b",
        PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
            // marking all parent flag hidden
            cmd.Parent().Flags().VisitAll(
                func(f *pflag.Flag) {
                    cmd.Flags().MarkHidden(f.Name)
                },
            )

            // enabling flag parsing
            cmd.DisableFlagParsing = false

            if err := cmd.ParseFlags(args); err != nil {
                return err
            }
            if cmd.Flag("help").Changed {
                err := cmd.Help()
                if err != nil {
                    return err
                }
                os.Exit(0)
            }
            return nil
        },
        RunE: func(cmd *cobra.Command, args []string) error {
            return cmd.help()
        },
    }
    
    //Diasbling flag parsing
    rootCommand.DisableFlagParsing = true

    return rootCommand
}

今天带大家了解了的相关知识,希望对你有所帮助;关于Golang的技术知识我们会一点点深入介绍,欢迎大家关注golang学习网公众号,一起学习编程~

版本声明
本文转载于:stackoverflow 如有侵犯,请联系study_golang@163.com删除
sys 模块中涉及 I/O 操作的疑问sys 模块中涉及 I/O 操作的疑问
上一篇
sys 模块中涉及 I/O 操作的疑问
探讨Go语言泛型的发展前景
下一篇
探讨Go语言泛型的发展前景
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    543次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    516次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    500次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    485次学习
查看更多
AI推荐
  • ChatExcel酷表:告别Excel难题,北大团队AI助手助您轻松处理数据
    ChatExcel酷表
    ChatExcel酷表是由北京大学团队打造的Excel聊天机器人,用自然语言操控表格,简化数据处理,告别繁琐操作,提升工作效率!适用于学生、上班族及政府人员。
    3168次使用
  • Any绘本:开源免费AI绘本创作工具深度解析
    Any绘本
    探索Any绘本(anypicturebook.com/zh),一款开源免费的AI绘本创作工具,基于Google Gemini与Flux AI模型,让您轻松创作个性化绘本。适用于家庭、教育、创作等多种场景,零门槛,高自由度,技术透明,本地可控。
    3381次使用
  • 可赞AI:AI驱动办公可视化智能工具,一键高效生成文档图表脑图
    可赞AI
    可赞AI,AI驱动的办公可视化智能工具,助您轻松实现文本与可视化元素高效转化。无论是智能文档生成、多格式文本解析,还是一键生成专业图表、脑图、知识卡片,可赞AI都能让信息处理更清晰高效。覆盖数据汇报、会议纪要、内容营销等全场景,大幅提升办公效率,降低专业门槛,是您提升工作效率的得力助手。
    3410次使用
  • 星月写作:AI网文创作神器,助力爆款小说速成
    星月写作
    星月写作是国内首款聚焦中文网络小说创作的AI辅助工具,解决网文作者从构思到变现的全流程痛点。AI扫榜、专属模板、全链路适配,助力新人快速上手,资深作者效率倍增。
    4514次使用
  • MagicLight.ai:叙事驱动AI动画视频创作平台 | 高效生成专业级故事动画
    MagicLight
    MagicLight.ai是全球首款叙事驱动型AI动画视频创作平台,专注于解决从故事想法到完整动画的全流程痛点。它通过自研AI模型,保障角色、风格、场景高度一致性,让零动画经验者也能高效产出专业级叙事内容。广泛适用于独立创作者、动画工作室、教育机构及企业营销,助您轻松实现创意落地与商业化。
    3790次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议隐私政策
返回登录
  • 重置密码