@colin4k1024/tsp 2.4.0

package/skills/goframe-v2/references//345/274/200/345/217/221/345/267/245/345/205/267//345/267/245/345/205/267/345/256/211/350/243/205-install.md

@@ -0,0 +1,80 @@
+该命令仅针对于预编译二进制下载安装。如果通过 `go install` 命名安装的工具的话，不需要手动再使用 `install` 命令安装 `gf` 工具。
+
+## 下载安装
+
+### 最新版下载
+
+#### `Mac`&`Linux`  快捷下载命令
+
+```bash
+wget -O gf https://github.com/gogf/gf/releases/latest/download/gf_$(go env GOOS)_$(go env GOARCH) && chmod +x gf && ./gf install -y && rm ./gf
+```
+
+#### Windows 需手动下载
+
+确定自己当前项目的 `goframe` 依赖版本，查看自己的系统信息：
+
+```bash
+go env GOOS
+go env GOARCH
+```
+
+下载地址： [releases](https://github.com/gogf/gf/releases)
+
+### 通过 `go install` 安装
+
+注意：需要将 `$GOPATH/bin` 加入到系统环境变量中，通过 `go env GOPATH` 查看。
+
+#### 最新版本
+
+```bash
+go install github.com/gogf/gf/cmd/gf/v2@latest
+```
+
+#### 指定版本(版本需要 >= v2.5.5)
+
+```bash
+go install github.com/gogf/gf/cmd/gf/v2@v2.5.5
+```
+
+### 其它版本下载
+
+#### v2 版本
+
+预编译二进制下载： [releases](https://github.com/gogf/gf/releases)
+
+源码：[gf/cmd/gf](https://github.com/gogf/gf/tree/master/cmd/gf)
+
+#### v1 版本
+
+预编译二进制下载： [releases](https://github.com/gogf/gf-cli/releases)
+
+源码： [gogf/gf-cli](https://github.com/gogf/gf-cli)
+
+## 使用方式
+
+项目地址： [https://github.com/gogf/gf/tree/master/cmd/gf](https://github.com/gogf/gf/tree/master/cmd/gf)
+
+使用方式： `./gf install`
+
+该命令往往是在 `gf` 命令行工具下载到本地后执行（注意执行权限），用于将 `gf` 命令安装到系统环境变量默认支持的目录路径中，以便于在系统任何的地方直接可以使用 `gf` 工具。
+
+:::note
+部分系统需要管理员权限支持。
+
+如果是 `MacOS` 下使用 `zsh` 的小伙伴可能会遇到别名冲突问题，可以通过 `alias gf=gf` 来解决，运行一次之后 `gf` 工具会自动修改 `profile` 中的别名设置，用户重新登录（或者重开终端）就好了。
+:::
+
+## 使用示例
+
+```bash
+$ ./gf_darwin_amd64 install
+I found some installable paths for you(from $PATH):
+  Id | Writable | Installed | Path
+   0 |     true |      true | /usr/local/bin
+   1 |     true |     false | /Users/john/Workspace/Go/GOPATH/bin
+   2 |     true |     false | /Users/john/.gvm/bin
+   4 |     true |     false | /Users/john/.ft
+please choose one installation destination [default 0]:
+gf binary is successfully installed to: /usr/local/bin
+```

package/skills/goframe-v2/references//345/274/200/345/217/221/345/267/245/345/205/267//345/274/200/345/217/221/345/267/245/345/205/267.md

@@ -0,0 +1,86 @@
+`GoFrame` 框架提供了功能强大的 `gf` 命令行开发辅助工具，是框架发展的一个重要组成部分，工具地址：
+
+- [https://github.com/gogf/gf/tree/master/cmd/gf](https://github.com/gogf/gf/tree/master/cmd/gf)
+
+工具安装请参考仓库页面。工具安装成功后，可以通过 `gf` 或者 `gf -h` 查看所有支持的命令。复杂的命令可以通过 `gf COMMAND -h` 查看更详细的使用帮助信息，例如： `gf gen -h`。
+
+## 工具职责
+
+1. 简化工程开发，提高开发效率
+2. 支持框架工程设计规范准确落地
+
+## 注意事项
+
+1. 部分命令需要您先安装好 `Golang` 基础的开发环境，环境安装具体请参考 [环境安装](../其他资料/准备开发环境/环境安装.md) 章节。
+2. 最新的 `CLI` 工具版本会随着最新的框架版本走。
+
+## 配置支持
+
+**工具的所有命令均同时支持命令行及配置文件配置参数，以提高易用性。当给定命令行参数时优先读取命令行参数，如果命令行参数不存在时，自动读取配置文件中对应的参数名称。**
+
+配置文件路径优先查找当前目录下的 `hack` 目录（ `hack/config.yaml`），其次按照框架默认的配置路径检索配置文件。框架默认的配置文件检索路径请参考章节： [配置管理-文件配置](../核心组件/配置管理/配置管理-文件配置.md)
+
+配置文件的格式示例：
+
+```yaml
+# 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
+
+  docker:
+    build: "-a amd64 -s linux -p temp"
+    tagPrefixes:
+    - ccr.ccs.tencentyun.com/xxx
+    - hkccr.ccs.tencentyun.com/xxx
+    - sgccr.ccs.tencentyun.com/xxx
+```
+
+注意以上配置示例仅供参考，具体配置项请参考具体命令帮助。
+
+## 工具调试
+
+当在工具的使用中遇到问题时，可以尝试打开工具的调试模式获得更详细的工具执行日志信息，打开工具调试模式可以通过 `debug` 命令行选项开启，例如：
+
+```bash
+gf build main.go --debug
+```
+
+由于 `gf` 工具也是使用 `GoFrame` 框架开发，因此调试信息的开启也是同框架方式一致，更详细的介绍请参考框架介绍文档： [调试模式](../核心组件/调试模式.md)
+
+## 命令总览
+
+当前帮助文档以 `gf cli v2.0.0` 版本为例进行简单的介绍，详细的介绍信息请查看命令行帮助信息。本章内容信息可能会有滞后，最新的具体详细介绍请查看工具帮助信息。
+
+```text
+$ 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.
+```
+
+## 相关文档

package/skills/goframe-v2/references//345/274/200/345/217/221/345/267/245/345/205/267//346/241/206/346/236/266/345/215/207/347/272/247-up.md

@@ -0,0 +1,67 @@
+:::tip
+该命令从框架 `v2.3` 版本开始提供。
+:::
+## 使用方式
+
+```text
+$ gf up -h
+USAGE
+    gf up [OPTION]
+
+OPTION
+    -a, --all    upgrade both version and cli, auto fix codes
+    -c, --cli    also upgrade CLI tool
+    -f, --fix    auto fix codes(it only make sense if cli is to be upgraded)
+    -h, --help   more information about this command
+
+EXAMPLE
+    gf up
+    gf up -a
+    gf up -c
+    gf up -cf
+```
+
+用以实现版本更新，同时更新主框架版本、社区组件版本到最新版本。
+
+选项说明：
+
+| 名称 | 含义 |
+| --- | --- |
+| `all` | 同时更新 `cli` 工具版本，并且自动修复本地代码在升级中的不兼容变更 |
+| `fix` | 升级时自动修复本地代码在升级中的不兼容变更 |
+| `cli` | 升级时同时更新 `cli` 工具版本 |
+
+## 使用示例
+
+```text
+$ gf up -a
+start upgrading version...
+upgrading "github.com/gogf/gf/contrib/drivers/mysql/v2" from "v2.2.4" to "latest"
+go: upgraded github.com/BurntSushi/toml v1.1.0 => v1.2.1
+go: upgraded github.com/cespare/xxhash/v2 v2.1.2 => v2.2.0
+go: upgraded github.com/clbanning/mxj/v2 v2.5.6 => v2.5.7
+go: upgraded github.com/fsnotify/fsnotify v1.5.4 => v1.6.0
+go: upgraded github.com/go-sql-driver/mysql v1.6.0 => v1.7.0
+go: upgraded github.com/gogf/gf/contrib/drivers/mysql/v2 v2.2.4 => v2.2.6
+go: upgraded github.com/gogf/gf/v2 v2.2.4 => v2.2.6
+go: upgraded github.com/magiconair/properties v1.8.6 => v1.8.7
+go: upgraded github.com/mattn/go-colorable v0.1.12 => v0.1.13
+go: upgraded github.com/mattn/go-isatty v0.0.14 => v0.0.17
+go: upgraded github.com/mattn/go-runewidth v0.0.13 => v0.0.14
+go: upgraded github.com/rivo/uniseg v0.2.0 => v0.4.3
+go: upgraded go.opentelemetry.io/otel v1.7.0 => v1.11.2
+go: upgraded go.opentelemetry.io/otel/sdk v1.7.0 => v1.11.2
+go: upgraded golang.org/x/net v0.0.0-20220621193019-9d032be2e588 => v0.5.0
+go: upgraded golang.org/x/sys v0.0.0-20220615213510-4f61da869c0c => v0.4.0
+go: upgraded golang.org/x/text v0.3.8-0.20220509174342-b4bca84b0361 => v0.6.0
+go: upgraded golang.org/x/tools v0.1.11-0.20220504162446-54c7ba520b92 => v0.1.12
+
+upgrading "github.com/gogf/gf/v2" from "v2.2.4" to "latest"
+
+auto fixing path "/Users/john/Workspace/Go/GOPATH/src/github.com/Khaos/eros"...
+done!
+```
+
+## 注意事项
+
+命令执行前请 `git` 提交本地修改内容或执行目录备份。

package/skills/goframe-v2/references//345/274/200/345/217/221/345/267/245/345/205/267//347/211/210/346/234/254/346/237/245/347/234/213-version.md

@@ -0,0 +1,53 @@
+## 使用方式
+
+- `gf -v`
+- `gf version`
+
+用以查看当前 `gf` 命令行工具编译时的版本信息。
+
+## 使用示例
+
+### `>= v2.5.7`
+
+```text
+$ gf version
+v2.7.2
+Welcome to GoFrame!
+Env Detail:
+  Go Version: go1.22.2 linux/amd64
+  GF Version(go.mod):
+    github.com/gogf/gf/contrib/drivers/mysql/v2@v2.7.2
+    github.com/gogf/gf/v2@v2.7.2
+CLI Detail:
+  Installed At: /data/home/v_hlaghuang/go/bin/gf
+  Built Go Version: go1.20.8
+  Built GF Version: v2.7.2
+  Git Commit: 2024-06-26 10:08:04 b11caba5b03ed54fbb1415151f7d62b6d913179d
+  Built Time: 2024-06-26 10:09:50
+Others Detail:
+  Docs: https://goframe.org
+  Now : 2024-07-17T15:48:57+08:00
+```
+
+### `< v2.5.6`
+
+```text
+$ gf version
+GoFrame CLI Tool v2.0.0, https://goframe.org
+GoFrame Version: v2.0.0-beta.0.20211214160159-19c9f0a48845 in current go.mod
+CLI Installed At: /Users/john/Workspace/Go/GOPATH/src/github.com/gogf/gf-cli/main
+CLI Built Detail:
+  Go Version:  go1.16.3
+  GF Version:  v2.0.0-beta
+  Git Commit:  2021-12-15 22:43:12 7884058b5df346d34ebab035224e415afb556c19
+  Build Time:  2021-12-15 23:00:43
+```
+
+## 注意事项
+
+在打印的版本信息中会自动检测当前项目使用的 `GoFrame` 版本（自动解析 `go.mod`），并以 `GoFrame Version` 的信息打印出来。
+
+在 `CLI Built Detail` 信息中展示的是当前二进制编译时使用的各种 `Golang` 版本以及 `GoFrame` 版本信息，编译时的 `Git` 提交版本、当前二进制文件的编译时间。
+:::warning
+大家请勿将 `GoFrame Version` 和 `CLI Built Detail` 中的 `GF Version` 混淆。
+:::

package/skills/goframe-v2/references//345/274/200/345/217/221/345/267/245/345/205/267//350/207/252/345/212/250/347/274/226/350/257/221-run.md

@@ -0,0 +1,86 @@
+## 注意事项
+
+由于 `Go` 是不支持热编译特性的，每一次代码变更后都要重新手动停止、编译、运行代码文件。 `run` 命令也不是实现热编译功能，而是提供了自动编译功能，当开发者修改了项目中的 `go` 文件时，该命令将会自动编译当前程序，并停止原有程序，运行新版的程序。
+:::tip
+`run` 命令会递归监控 **当前运行目录** 的所有 `go` 文件变化来实现自动编译。
+:::
+## 使用帮助
+
+```text
+$ gf run -h
+USAGE
+    gf run FILE [OPTION]
+
+ARGUMENT
+    FILE    building file path.
+
+OPTION
+    -p, --path         output directory path for built binary file. it's "./" in default
+    -e, --extra        the same options as "go run"/"go build" except some options as follows defined
+    -a, --args         custom arguments for your process
+    -w, --watchPaths   watch additional paths for live reload, separated by ",". i.e. "manifest/config/*.yaml"
+    -h, --help         more information about this command
+
+EXAMPLE
+    gf run main.go
+    gf run main.go --args "server -p 8080"
+    gf run main.go -mod=vendor
+    gf run main.go -w "manifest/config/*.yaml"
+
+DESCRIPTION
+    The "run" command is used for running go codes with hot-compiled-like feature,
+    which compiles and runs the go codes asynchronously when codes change.
+
+```
+
+配置文件格式示例：
+
+```yaml
+gfcli:
+  run:
+    path:  "./bin"
+    extra: ""
+    args:  "all"
+    watchPaths:
+    - api/*.go
+    - internal/controller/*.go
+```
+
+参数介绍：
+
+| 名称 | 默认值 | 含义 | 示例 |
+| --- | --- | --- | --- |
+| `path` | `./` | 指定编译后生成的二进制文件存放目录。 |  |
+| `extra` |  | 指定用于底层 `go build` 的命令参数 |  |
+| `args` |  | 指定启动运行二进制文件的命令行参数 |  |
+| `watchPath` |  | 指定本地项目文件监听的文件路径格式，支持多个路径使用 `,` 覆盖分隔。该参数的格式同标准库的 `filepath.Match` 方法参数 | `internal/*.go` |
+
+## 使用示例
+
+一般 `gf run main.go` 即可
+
+```text
+$ gf run main.go --swagger
+2020-12-31 00:40:16.948 build: main.go
+2020-12-31 00:40:16.994 producing swagger files...
+2020-12-31 00:40:17.145 done!
+2020-12-31 00:40:17.216 gf pack swagger packed/swagger.go -n packed -y
+2020-12-31 00:40:17.279 done!
+2020-12-31 00:40:17.282 go build -o bin/main  main.go
+2020-12-31 00:40:18.696 go file changes: "/Users/john/Workspace/Go/GOPATH/src/github.com/gogf/gf-demos/packed/swagger.go": WRITE
+2020-12-31 00:40:18.696 build: main.go
+2020-12-31 00:40:18.775 producing swagger files...
+2020-12-31 00:40:18.911 done!
+2020-12-31 00:40:19.045 gf pack swagger packed/swagger.go -n packed -y
+2020-12-31 00:40:19.136 done!
+2020-12-31 00:40:19.144 go build -o bin/main  main.go
+2020-12-31 00:40:21.367 bin/main
+2020-12-31 00:40:21.372 build running pid: 40954
+2020-12-31 00:40:21.437 [DEBU] [ghttp] SetServerRoot path: /Users/john/Workspace/Go/GOPATH/src/github.com/gogf/gf-demos/public
+2020-12-31 00:40:21.440 40954: http server started listening on [:8199]
+...
+```
+
+## 常见问题
+
+[too many open files on macOS](https://github.com/fsnotify/fsnotify/issues/129)

package/skills/goframe-v2/references//345/274/200/345/217/221/345/267/245/345/205/267//350/265/204/346/272/220/346/211/223/345/214/205-pack.md

@@ -0,0 +1,42 @@
+## 使用方式
+
+```text
+$ gf pack -h
+USAGE
+    gf pack SRC DST
+
+ARGUMENT
+    SRC    source path for packing, which can be multiple source paths.
+    DST    destination file path for packed file. if extension of the filename is ".go" and "-n" option is given,
+           it enables packing SRC to go file, or else it packs SRC into a binary file.
+
+OPTION
+    -n, --name       package name for output go file, it's set as its directory name if no name passed
+    -p, --prefix     prefix for each file packed into the resource file
+    -k, --keepPath   keep the source path from system to resource file, usually for relative path
+    -h, --help       more information about this command
+
+EXAMPLE
+    gf pack public data.bin
+    gf pack public,template data.bin
+    gf pack public,template packed/data.go
+    gf pack public,template,config packed/data.go
+    gf pack public,template,config packed/data.go -n=packed -p=/var/www/my-app
+    gf pack /var/www/public packed/data.go -n=packed
+```
+
+该命令用以将任意的文件打包为资源文件或者 `Go` 代码文件，可将任意文件打包后随着可执行文件一同发布。此外，在 `build` 命令中支持打包+编译一步进行，具体请查看 `build` 命令帮助信息。关于资源管理的介绍请参考 [资源管理](../核心组件/资源管理/资源管理.md) 章节。
+
+## 使用示例
+
+```text
+$ gf pack public,template packed/data.go
+done!
+$ ll packed
+total 184
+-rw-r--r--  1 john  staff    89K Dec 31 00:44 data.go
+```
+
+## 延伸阅读
+
+- [资源管理-最佳实践](../核心组件/资源管理/资源管理-最佳实践.md)

package/skills/goframe-v2/references//345/274/200/345/217/221/345/267/245/345/205/267//351/225/234/345/203/217/347/274/226/350/257/221-docker.md

@@ -0,0 +1,113 @@
+:::tip
+从 `v2.5` 版本开始，为提高命令解耦性，`gf docker` 命令默认不再执行二进制编译。推荐使用 `Makefile` 构建脚本组合 `gf build`、`gf gen enums`、`gf docker` 等命令（工程项目中提供了 `make build`、`make enums`、`make docker` 命令），这种方式更灵活且易于维护。
+:::
+## 使用方式
+
+```text
+$ gf docker -h
+USAGE
+    gf docker [MAIN] [OPTION]
+
+ARGUMENT
+    MAIN    main file path for "gf build", it's "main.go" in default. empty string for no binary build
+
+OPTION
+    -f, --file           file path of the Dockerfile. it's "manifest/docker/Dockerfile" in default
+    -s, --shell          path of the shell file which is executed before docker build
+    -b, --build          binary build options before docker image build, it's "-a amd64 -s linux" in default
+    -tn, --tagName       tag name for this docker, pattern like "image:tag". this option is required with TagPrefixes
+    -tp, --tagPrefixes   tag prefixes for this docker, which are used for docker push. this option is required with
+                         TagName
+    -p, --push           auto push the docker image to docker registry if "-t" option passed
+    -e, --extra          extra build options passed to "docker image"
+    -h, --help           more information about this command
+
+EXAMPLE
+    gf docker
+    gf docker -t hub.docker.com/john/image:tag
+    gf docker -p -t hub.docker.com/john/image:tag
+    gf docker main.go
+    gf docker main.go -t hub.docker.com/john/image:tag
+    gf docker main.go -t hub.docker.com/john/image:tag
+    gf docker main.go -p -t hub.docker.com/john/image:tag
+
+DESCRIPTION
+    The "docker" command builds the GF project to a docker images.
+    It runs "gf build" firstly to compile the project to binary file.
+    It then runs "docker build" command automatically to generate the docker image.
+    You should have docker installed, and there must be a Dockerfile in the root of the project.
+```
+
+自动编译并生成 Docker 镜像。`MAIN` 参数为可选的编译文件路径，默认为 `main.go`。`OPTIONS` 参数为可选的 `docker build` 命令参数及选项。
+
+该命令会自动完成以下流程：
+1. 执行 `gf build` 编译项目为二进制文件
+2. 执行 `docker build` 生成镜像
+3. 可选执行 `docker push` 推送镜像到仓库
+
+前提条件：
+- 系统已安装 Docker
+- 项目根目录存在 Dockerfile 文件
+
+## 使用示例
+
+```text
+$ gf docker main.go -p -tn loads/gf-demos:test
+2020-12-31 00:47:28.207 start building...
+2020-12-31 00:47:28.207 go build -o ./bin/linux_amd64/main main.go
+2020-12-31 00:47:35.894 done!
+Sending build context to Docker daemon  37.63MB
+Step 1/10 : FROM loads/alpine:3.8
+ ---> f9fb622e6db2
+Step 2/10 : LABEL maintainer="john@goframe.org"
+ ---> Using cache
+ ---> da238418d031
+Step 3/10 : ENV WORKDIR /var/www/gf-demos
+ ---> Using cache
+ ---> 3e7129c087c9
+Step 4/10 : ADD ./bin/linux_amd64/main   $WORKDIR/main
+ ---> 3661a9dea494
+Step 5/10 : RUN chmod +x $WORKDIR/main
+ ---> Running in 1d49d5d91080
+Removing intermediate container 1d49d5d91080
+ ---> a03ee04e3380
+Step 6/10 : ADD public   $WORKDIR/public
+ ---> 63dd06d0e1a3
+Step 7/10 : ADD config   $WORKDIR/config
+ ---> fa7a57eba577
+Step 8/10 : ADD template $WORKDIR/template
+ ---> 7075609b0447
+Step 9/10 : WORKDIR $WORKDIR
+ ---> Running in a34ef38e1031
+Removing intermediate container a34ef38e1031
+ ---> 580077998eaf
+Step 10/10 : CMD ./main
+ ---> Running in ed286b518ad9
+Removing intermediate container ed286b518ad9
+ ---> fbbc05842901
+Successfully built fbbc05842901
+Successfully tagged loads/gf-demos:test
+The push refers to repository [docker.io/loads/gf-demos]
+b4025b95a79f: Preparing
+9e0369a57507: Preparing
+46c68dcc8e12: Preparing
+59adbc083ee5: Preparing
+10e0b999ba57: Preparing
+8e850d7b086e: Waiting
+d5e057db20a2: Waiting
+92e898fd7f84: Waiting
+d9ff549177a9: Waiting
+...
+```
+
+## 配置文件示例
+
+推荐使用配置文件管理工具配置，在 `hack/config.yaml` 文件中维护。`docker` 命令配置示例：
+
+```yaml
+gfcli:
+  docker:
+    build: "-a amd64 -s linux -p temp -ew"
+    tagPrefixes:
+    - ccr.ccs.tencentyun.com/cdb.khaos.eros
+```