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

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

工具职责

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

注意事项

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

工具调试

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

  1. gf build main.go --gf.debug

由于gf工具也是使用GoFrame框架开发，因此调试信息的开启也是同框架方式一致，更详细的介绍请参考框架介绍文档：调试模式

命令总览

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

  1. $ gf
  2. USAGE
  3.    gf COMMAND [OPTION]
  5. COMMAND
  6.    env        show current Golang environment variables
  7.    run        running go codes with hot-compiled-like feature
  8.    gen        automatically generate go files for dao/dto/entity/pb/pbentity...
  9.    init       create and initialize an empty GoFrame project
  10.    pack       packing any file/directory to a resource file, or a go file
  11.    build      cross-building go project for lots of platforms
  12.    docker     build docker image for current GoFrame project
  13.    install    install gf binary to system (might need root/admin permission)
  14.    version    show version information of current binary
  16. OPTION
  17.    -y, --yes        all yes for all command without prompt ask
  18.    -v, --version    show version information of current binary
  19.    -d, --debug      show internal detailed debugging information
  20.    -h, --help       more information about this command
  22. ADDITIONAL
  23.     Use "gf COMMAND -h" for details about a command.

相关文档