Cobra 是一个用于创建强大的 CLI 应用程序的库，它支持命令行界面（CLI）和子命令，类似于 git。以下是使用 Cobra 库的基本步骤和示例：

1. 安装 Cobra

在项目中安装 Cobra 库：

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

2. 创建主命令文件

你可以使用单个 Go 文件来创建一个简单的 Cobra 应用程序。以下是一个基本示例：

main.go

package main

import (
    "fmt"
    "os"

    "github.com/spf13/cobra"
)

func main() {
    var rootCmd = &cobra.Command{
        Use:   "app",
        Short: "App is a CLI application",
    }

    var echoCmd = &cobra.Command{
        Use:   "echo [words]",
        Short: "Prints the words to the console",
        Args:  cobra.MinimumNArgs(1),
        Run: func(cmd *cobra.Command, args []string) {
            for _, word := range args {
                fmt.Println(word)
            }
        },
    }

    rootCmd.AddCommand(echoCmd)
    if err := rootCmd.Execute(); err != nil {
        fmt.Println(err)
        os.Exit(1)
    }
}

3. 运行应用程序

编译并运行你的应用程序：

go run main.go echo hello world

输出将是：

hello
world

4. 使用 Cobra Generator 生成一个项目

Cobra 提供了一个生成器脚本来初始化和设置你的项目结构。

安装 Cobra Generator

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

创建新项目

cobra-cli init [project-name]

例如：

cobra-cli init myapp

这将生成一个基本的项目结构：

myapp/
├── cmd
│   └── root.go
├── main.go

添加命令

使用 Cobra Generator 添加新命令：

cobra-cli add [command-name]

例如：

cobra-cli add echo

这将在 cmd 目录下创建一个新的命令文件：

myapp/
├── cmd
│   ├── echo.go
│   └── root.go
├── main.go

修改命令文件

编辑 cmd/echo.go 文件，实现你的命令逻辑：

package cmd

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

// echoCmd represents the echo command
var echoCmd = &cobra.Command{
    Use:   "echo [words]",
    Short: "Prints the words to the console",
    Args:  cobra.MinimumNArgs(1),
    Run: func(cmd *cobra.Command, args []string) {
        for _, word := range args {
            fmt.Println(word)
        }
    },
}

func init() {
    rootCmd.AddCommand(echoCmd)
    // Here you will define your flags and configuration settings.
}

使用总结

通过上述步骤，你可以使用 Cobra 创建一个强大的 CLI 应用程序，支持多个子命令和复杂的命令行解析。你可以根据需要进一步扩展和定制每个命令的逻辑和参数。

最后修改于 2024-09-20