GoFrame框架提供了功能强大的gf命令行开发辅助工具,是框架发展的一个重要组成部分,工具开源项目地址:https://github.com/gogf/gf-cli

我们推荐通过下载安装预编译的二进制使用。工具安装成功后,可以通过gf或者gf -h查看所有支持的命令。复杂的命令可以通过gf help COMMAND或者gf COMMAND -h查看更详细的使用帮助信息,例如:gf help gengf gen -h

注意事项

1、工具运行初始化时将会自动打开Go Modules特性并设置反向代理地址为 https://goproxy.cn

2、部分命令需要您先安装好Golang基础的开发环境,环境安装具体请参考 环境安装 章节。

3、最新的CLI工具版本会随着最新的框架版本走。

命令总览

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

$ gf 
USAGE
    gf COMMAND [ARGUMENT] [OPTION]

COMMAND
    env        show current Golang environment variables
    get        install or update GF to system in default...
    gen        automatically generate go files for ORM models...
    mod        extra features for go modules...
    run        running go codes with hot-compiled-like feature...
    init       create and initialize an empty GF project...
    help       show more information about a specified command
    pack       packing any file/directory to a resource file, or a go file...
    build      cross-building go project for lots of platforms...
    docker     create a 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)
    install    install gf binary to system (might need root/admin permission)
    version    show current binary version info

OPTION
    -y         all yes for all command without prompt ask 
    -?,-h      show this help or detail for specified command
    -v,-i      show version information

ADDITIONAL
    Use 'gf help COMMAND' or 'gf COMMAND -h' for detail about a command, which has '...' 
    in the tail of their comments.











  • No labels

4 Comments

  1. USAGE
        gf COMMAND [ARGUMENT] [OPTION]

    COMMAND
        env        查看golang的环境变量
        get        依赖包下载
        gen        自动生成 ORM代码
        mod        go modules的相关命令[扩展功能]    
    run 以热编译(自动编译)的方式运行代码 init 创建项目并初始化 help 查看命令的更多提示信息 pack 打包文件或目录 到资源文件或一个go文件 build 交叉编译 docker 为当前项目创建docker镜像 swagger 使用swagger生成API文档 update 更新GF到最新版本 (可能需要管理员权限) install 安装GF (可能需要管理员权限)
      version 查看GF版本信息


    1. 这个怎么转换成中文的

      1. 我手动翻译的  哈哈😄

  2. gf  install 没有安装到PATH指定的路径中!