Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
GoFrame框架提供了功能强大的gf命令行开发辅助工具，是框架发展的一个重要组成部分，工具开源项目地址：命令行开发辅助工具，是框架发展的一个重要组成部分，工具地址：
工具安装请参考仓库页面。工具安装成功后，可以通过-cli我们推荐通过下载安装预编译的二进制使用。工具安装成功后，可以通过gf或者gf -h查看所有支持的命令。复杂的命令可以通过gf help COMMAND或者gf COMMAND -h查看更详细的使用帮助信息，例如：gf help gen 、gf gen -h。
工具职责
- 简化工程开发，提高开发效率
- 支持框架工程设计规范准确落地
注意事项
1、工具运行初始化时将会自动打开Go Modules特性并设置反向代理地址为 https://goproxy.cn 。
- 部分命令需要您先安装好
Golang基础的开发环境，环境安装具体请参考 环境安装 章节。
- 最新的
CLI工具版本会随着最新的框架版本走。
配置支持
命令总览
工具的所有命令均同时支持命令行及配置文件配置参数，以提高易用性。当给定命令行参数时优先读取命令行参数，如果命令行参数不存在时，自动读取配置文件中对应的参数名称。
配置文件路径优先查找当前目录下的hack目录（hack/config.yaml），其次按照框架默认的配置路径检索配置文件。框架默认的配置文件检索路径请参考章节：配置管理-文件配置
配置文件的格式示例：当前帮助文档以gf cli v1.15.0版本为例进行简单的介绍，详细的介绍信息请查看命令行帮助信息。本章内容信息可能会有滞后，最新的具体详细介绍请查看工具帮助信息。
| Code Block | |||
|---|---|---|---|
| |||
# GoFrame CLI tool configuration. gfcli: gen: dao: - link: "mysql:root:12345678@tcp(127.0.0.1:3306)/test" tables: "user" removePrefix: "gf_"$ gf USAGE gf COMMAND [ARGUMENT] [OPTION] COMMAND env descriptionTag: true show noModelComment: current Golangtrue environment variablesdocker: getbuild: "-a amd64 -s linux -p temp" install or updatetagPrefixes: GF to system in- defaultccr.ccs.tencentyun.com/xxx gen- hkccr.ccs.tencentyun.com/xxx - sgccr.ccs.tencentyun.com/xxx |
注意以上配置示例仅供参考，具体配置项请参考具体命令帮助。
工具调试
当在工具的使用中遇到问题时，可以尝试打开工具的调试模式获得更详细的工具执行日志信息，打开工具调试模式可以通过debug命令行选项开启，例如：
| Code Block | ||
|---|---|---|
| ||
gf build main.go --debug |
| Tip |
|---|
由于 |
命令总览
当前帮助文档以gf cli v2.0.0版本为例进行简单的介绍，详细的介绍信息请查看命令行帮助信息。本章内容信息可能会有滞后，最新的具体详细介绍请查看工具帮助信息。
| Code Block | ||
|---|---|---|
| ||
$ gf USAGE gf COMMAND [OPTION] COMMAND automatically generate go files for ORM models... env mod show extracurrent featuresGolang for go modules...environment variables run running go codes with hot-compiled-like feature... gen init createautomatically andgenerate initializego anfiles empty GF projectfor dao/dto/entity/pb/pbentity... init help create showand moreinitialize informationan aboutempty aGoFrame specified commandproject pack packing any file/directory to a resource file, or a go file... build cross-building go project for lots of platforms... docker create abuild docker image for current GF project... swagger swagger feature for current project... update update current gf binary to latest one (might need root/admin permission) GoFrame project install install gf binary to system (might need root/admin permission) version show version information of current binary version info OPTION -y, --yes all yes for all command without prompt ask -v, -?,-hversion show thisversion helpinformation orof detail for specified commandcurrent binary -d, -v,-idebug show versioninternal detailed debugging information ADDITIONAL Use 'gf help COMMAND' or 'gf COMMAND -h' for detail about a command, which has '...' in the tail of their comments. -h, --help more information about this command ADDITIONAL Use "gf COMMAND -h" for details about a command. |
相关文档
| Children Display | ||||
|---|---|---|---|---|
|
| Panel | ||
|---|---|---|
| ||
|