goframe api GoFrame 开发工具-简介

​GoFrame​框架提供了功能强大的​gf​命令行开发辅助工具，是框架发展的一个重要组成部分，工具地址：

• https://github.com/gogf/gf/tree/master/cmd/gf

工具安装请参考仓库页面。工具安装成功后，可以通过​gf​或者​gf -h​查看所有支持的命令。复杂的命令可以通过​gf COMMAND -h​查看更详细的使用帮助信息，例如：​gf gen -h​。

工具职责

1. 简化工程开发，提高开发效率
2. 支持框架工程设计规范准确落地

注意事项

1. 部分命令需要您先安装好Golang基础的开发环境。
2. 最新的​CLI​工具版本会随着最新的框架版本走。

配置支持

工具的所有命令均同时支持命令行及配置文件配置参数，以提高易用性。配置文件路径优先查找当前目录下的​hack​目录，其次按照框架默认的配置路径检索配置文件。

以​gf gen dao​命令的配置文件的格式示例：

# GoFrame CLI tool configuration.
gfcli:
  gen:
    dao:
    - link:            "mysql:root:12345678@tcp(127.0.0.1:3306)/test"
      tables:          "user"
      removePrefix:    "gf_"
      descriptionTag:  true
      noModelComment:  true

注意以上配置示例仅供参考，具体配置项请参考具体命令帮助。

工具调试

当在工具的使用中遇到问题时，可以尝试打开工具的调试模式获得更详细的工具执行日志信息，打开工具调试模式可以通过​gf.debug​命令行选项开启，例如：

gf build main.go --gf.debug

由于​gf​工具也是使用​GoFrame​框架开发，因此调试信息的开启也是同框架方式一致。

命令总览

当前帮助文档以​gf cli v2.0.0​版本为例进行简单的介绍，详细的介绍信息请查看命令行帮助信息。本章内容信息可能会有滞后，最新的具体详细介绍请查看工具帮助信息。

$ gf
USAGE
   gf COMMAND [OPTION]

COMMAND
   env        show current Golang environment variables
   run        running go codes with hot-compiled-like feature
   gen        automatically generate go files for dao/dto/entity/pb/pbentity...
   init       create and initialize an empty GoFrame project
   pack       packing any file/directory to a resource file, or a go file
   build      cross-building go project for lots of platforms
   docker     build docker image for current GoFrame project
   install    install gf binary to system (might need root/admin permission)
   version    show version information of current binary

OPTION
   -y, --yes        all yes for all command without prompt ask
   -v, --version    show version information of current binary
   -d, --debug      show internal detailed debugging information
   -h, --help       more information about this command

ADDITIONAL
    Use "gf COMMAND -h" for details about a command.