基本介绍

程序需要通过命令行来管理程序启动入口，因此命令行管理组件也是框架的核心组件之一。 GoFrame 框架提供了强大的命令行管理模块，由 gcmd 组件实现。

使用方式：

  1. import "github.com/gogf/gf/v2/os/gcmd"

接口文档：

https://pkg.go.dev/github.com/gogf/gf/v2/os/gcmd

组件特性

gcmd 组件具有以下显著特性：

  • 使用简便、功能强大
  • 命令行参数管理灵活
  • 支持灵活的 Parser 命令行自定义解析
  • 支持多层级的命令行管理、更丰富的命令行信息
  • 支持对象模式结构化输入/输出管理大批量命令行
  • 支持参数结构化自动类型转换、自动校验
  • 支持参数结构化从配置组件读取数据
  • 支持自动生成命令行帮助信息
  • 支持终端录入功能

与 Cobra 比较

Cobra 是 Golang 中使用比较广泛的命令行管理库，开源项目地址： https://github.com/spf13/cobra

GoFrame 框架的 gcmd 命令行组件与 Cobra 比较，基础的功能比较相似，但差别比较大的在于参数管理方式以及可观测性支持方面：

  • gcmd 组件支持结构化的参数管理，支持层级对象的命令行管理、方法自动生成命令，无需开发者手动定义手动解析参数变量。
  • gcmd 组件支持自动化的参数类型转换，支持基础类型以及复杂类型。
  • gcmd 组件支持可配置的常用参数校验能力，提高参数维护效率。
  • gcmd 组件支持没有终端传参时通过配置组件读取参数方式。
  • gcmd 组件支持链路跟踪，便于父子进程的链路信息传递。

相关文档

📄️ 命令管理-基本概念GoFrame框架中的命令行参数和选项的基本概念，讨论了参数与选项的定义、区别及其在命令行中的表现方式。详细解释了选项与参数的解析规则，包括使用等号连接选项与数据的情况。并提供了gcmd组件在GoFrame中的实现细节和使用示例，以帮助用户更好地管理命令行输入。

📄️ 命令管理-基础方法GoFrame框架中的gcmd组件基本功能，包括如何获取命令行参数和选项及其常用方法。通过示例讲解如何使用Init方法自定义命令行数据，以及如何利用GetArg和GetOpt方法分别获取命令行参数和选项，详细展示了参数获取和选项获取的实现，帮助开发者快速掌握GoFrame中的命令管理功能。

📄️ 命令管理-Parser解析GoFrame框架的命令行解析功能，重点讲解了gcmd组件的Parser解析方法。通过自定义选项名称和数值解析，能够高效管理和解析命令行选项。包括代码示例和详细的接口文档，帮助开发者理解和应用于实际项目中。

📄️ 命令管理-命令行对象使用GoFrame框架中的gcmd库管理命令行对象和命令，涵盖了Command对象的定义、回调方法的使用以及命令的层级管理。同时，提供了在GoFrame框架下启动HTTP和gRPC服务的命令行实现示例，展示了如何为命令增加子命令，并自动生成帮助信息。

📄️ 命令管理-结构化参数通过GoFrame框架实现命令行管理的结构化参数处理。通过对象化管理父级及子级命令，定义规范化的输入参数对象，实现命令行的自动数据转换及校验功能。通过GoFrame的框架开发工具，用户可以轻松管理多个命令行项目，支持从配置中读取数据，提升项目的开发效率和稳定性。

📄️ 命令管理-终端交互GoFrame框架中的gcmd组件，用于在终端环境中实现与用户的交互。主要提供了Scan和Scanf两个核心方法，通过这些方法可以便捷地从终端读取用户输入，并在命令行界面中进行交互展示。这些实用功能适用于需要与用户数据输入交互的命令行程序开发。

📄️ 命令管理-链路跟踪使用GoFrame框架的命令管理组件进行链路跟踪。通过OpenTelemetry规范，使用GoFrame可以实现跨进程的链路跟踪，特别适用于临时运行的进程。示例中展示了如何通过主进程调用子进程，并自动传递链路信息。