Gookit Gcli

Gookit GCli Skill

Golang 编写的简单易用的命令行应用和工具库。

Quick Start

go get github.com/gookit/gcli/v3

package main

import (
    "github.com/gookit/gcli/v3"
)

func main() {
    app := gcli.NewApp()
    app.Version = "1.0.3"
    app.Desc = "my cli application"

    app.Add(&gcli.Command{
        Name:    "demo",
        Desc:    "demo command",
        Aliases: []string{"dm"},
        Func: func(cmd *gcli.Command, args []string) error {
            gcli.Println("hello, in the demo command")
            return nil
        },
    })

    app.Run(nil)
}

核心功能

命令管理

• 多命令支持 - 添加多个命令及其别名
• 多级子命令 - 支持嵌套命令结构
• 自动帮助生成 - 命令执行错误时提示相似命令

详细用法见 references/commands.md

选项与参数

• 选项绑定 - 支持 --long 长选项和 -s 短选项
• 结构体绑定 - 通过标签绑定选项和参数
• 参数取值 - AddArg 声明后用 c.Arg("name").String()/.Strings() 读取
• 解析顺序 - 选项须在位置参数之前（遇首个非选项即停，不做交错解析）
• -- 透传 - gcli 原生终止解析，用末尾数组参数承接 -- <argv...>
• 验证器 - 自定义参数验证
• POSIX 风格 - 支持短选项组合 (-ab)

详细用法见 references/flags-args.md（含解析顺序坑、-- 透传、伪 subcommand not found 提示的消除）

颜色与交互

• 颜色输出 - 丰富的终端颜色渲染，Windows 兼容
• 用户交互 - 输入读取、确认选择、多选列表
• 进度显示 - 进度条、加载动画、文字动态更新

详细用法见 references/color-interact.md

数据展示

• 列表 - show.AList/MList 输出键值列表
• JSON - show.JSON(v) 格式化输出
• Banner/Title - 标题横幅与标题行
• 表格 - show/table 包，支持手动行、struct slice 自动映射、8 种样式

详细用法见 references/data-show.md

高级功能

• 自动补全 - 生成 bash/zsh 补全脚本
• 独立命令 - 单命令作为独立应用运行
• 错误处理 - 自动渲染错误提示

详细用法见 references/advanced.md

常用场景

相关链接

• Godoc
• GitHub
• gookit/color - 颜色库