安装与命令行工具：gf-cli 安装与 gf init 建项目

引言

GoFrame 官方提供命令行工具 gf-cli（简称 gf），用于创建项目、生成代码、编译运行等。本文介绍 gf-cli 的安装，以及用 gf init 快速创建项目的方法。环境要求与安装细节以官方文档 goframe.org 的 CLI 安装章节为准。

概念

gf-cli 是 GoFrame 官方的工程辅助工具，常用命令包括：

• gf init：初始化项目骨架（官方单仓目录结构）。
• gf run：开发模式下编译运行。
• gf build：交叉编译发布产物。
• gf gen：根据配置生成代码（dao、service 等）。
• gf up：升级 gf-cli 自身。

安装前请先准备好 Go 环境（可在终端执行 go version 确认）。gf-cli 本身是一个 Go 程序，v2 官方推荐的安装方式是 go install。

代码示例

安装与验证：

# 1. 安装 gf-cli（二进制输出到 GOPATH/bin 下）
go install github.com/gogf/gf/cmd/gf/v2@latest

# 2. 确保 GOPATH/bin 在 PATH 中，然后验证版本与帮助
gf -v
gf -h

创建项目（会在当前目录下生成名为 demo 的项目文件夹）：

# 3. 初始化项目
gf init demo

# 4. 进入项目并拉取依赖
cd demo
go mod tidy

# 5. 开发运行（等价于编译后执行，可热编译）
gf run main.go

gf init demo 生成的关键内容如下（后续章节会逐个讲解）：

demo/
├── main.go                  # 程序入口
├── go.mod                   # 模块定义（module demo）
├── Makefile
├── api/                     # 对外接口定义
├── internal/                # 内部实现（cmd/controller/dao/logic/service 等）
├── hack/                    # 开发工具脚本
├── manifest/config/         # 配置文件（config.yaml）
└── resource/                # 静态资源（public/template 等）

注意点

• 若 gf 命令找不到，说明 GOPATH/bin（默认 $HOME/go/bin）不在 PATH 中，请先配置环境变量。
• go install ...@latest 需要可访问 Go module 代理；国内环境可按官方文档配置 GOPROXY。
• gf init 生成的骨架结构会随版本演进略有差异，具体以实际生成为准。
• 本书后续示例若需要标准工程结构，都以此处生成的骨架为基础。

小结

gf-cli 是使用 GoFrame v2 的起点：先安装，再 gf init 生成工程，最后 go mod tidy + gf run 跑起来。下一章我们抛开脚手架，手写最小的 main.go，理解 g.Server() 是如何启动应用的。命令完整清单以官方文档 goframe.org 的 CLI 章节为准。