如何将Cobra子命令源码放入独立目录？

核心结论 #

这不是Cobra无法实现的功能，也不需要脱离Cobra Generator，更不属于不良设计——这种按子目录拆分的结构反而适合多团队、多命令的大型项目，能有效降低耦合、提升可维护性。

你遇到问题的原因 #

1. 构建成功但命令未找到：调整目录后，新子包未被主入口导入，导致命令注册的init函数未执行，命令没有添加到根命令树中。
2. rootCmd未定义：原rootCmd是小写未导出变量，跨包无法访问，必须改成首字母大写的导出变量才能被其他子包引用。

正确实现步骤 #

假设你当前的cmd目录是平结构，现在要拆分按团队/命令组划分的子目录，具体操作如下：

1. 调整目录结构
   按命令所属的团队/功能组创建独立子目录，比如：

   cmd/
     root/          # 根命令目录
       root.go
     teamA/         # 团队A的命令集
       cmd1.go
       cmd1_sub.go
     teamB/         # 团队B的命令集
       cmd2.go
   

2. 修改命令文件的包声明与变量导出

   • 根命令文件（cmd/root/root.go）：将rootCmd改为首字母大写的导出变量，包名设为root

     package root
     
     import "github.com/spf13/cobra"
     
     // RootCmd 导出根命令，供其他包引用
     var RootCmd = &cobra.Command{
       Use:   "mycli",
       Short: "自定义CLI工具",
       // 其他配置...
     }
     

   • 子命令文件（比如cmd/teamA/cmd1.go）：包名设为teamA，子命令变量同样导出，在init函数中把命令添加到根命令

     package teamA
     
     import (
       "github.com/spf13/cobra"
       "your-project-module-path/cmd/root"
     )
     
     // Cmd1Cmd 导出团队A的cmd1命令
     var Cmd1Cmd = &cobra.Command{
       Use:   "cmd1",
       Short: "团队A的命令1",
       // 其他配置...
     }
     
     func init() {
       // 将子命令注册到根命令
       root.RootCmd.AddCommand(Cmd1Cmd)
     }
     

3. 修改主入口文件（main.go）
   导入所有命令子包（使用空白标识符_触发init函数执行，完成命令注册），然后调用根命令的Execute方法：

   package main
   
   import (
     "your-project-module-path/cmd/root"
     _ "your-project-module-path/cmd/teamA" // 导入触发命令注册
     _ "your-project-module-path/cmd/teamB"
   )
   
   func main() {
     if err := root.RootCmd.Execute(); err != nil {
       panic(err)
     }
   }
   

4. 兼容Cobra Generator
   后续需要生成新命令时，可通过-p参数指定目标包（对应子目录），比如给teamB生成cmd3：

   cobra add cmd3 -p teamB
   

   生成后可能需要手动调整init函数中根命令的引用路径（改为root.RootCmd），确保命令能正确注册。

内容的提问来源于stack exchange，提问作者aTom