GoFrame CLI 工具快速入门指南

GoFrame CLI 工具快速入门指南

gf-cliGoFrame Command Line Interface, which is your helpmate for building GoFrame application with convenience.项目地址:https://gitcode.com/gh_mirrors/gf/gf-cli

1. 项目目录结构及介绍

GoFrame CLI 工具的源代码位于 https://github.com/gogf/gf-cli.git。以下是其主要目录结构：

gf-cli/
├── cmd/               # 包含各种命令的实现
│   ├── gf             # 主要的命令入口
│   └── ...
├── pkg/               # 通用功能包
│   ├── config         # 配置管理
│   ├── utils          # 辅助工具函数
│   └── ...
└── ...                 # 其他相关文件和目录

• cmd/ 存放着各种命令的实现，如 gf, gen, build 等。
• pkg/ 是公共库，包括配置管理和一些辅助工具。

2. 项目的启动文件介绍

在 GoFrame CLI 中，启动文件通常指的是 main.go 文件。尽管在 gf-cli 的仓库中它可能不是一个标准的应用程序，但它包含了主命令的定义和入口点。例如，cmd/gf/main.go 文件定义了 gf 命令的行为。

package main

import (
	"github.com/gogf/gf-cli/v2"
)

func main() {
	gfcli.Run()
}

这里的 gfcli.Run() 调用启动了命令行解析并执行相应操作。

3. 项目的配置文件介绍

GoFrame CLI 支持通过配置文件来定制命令的参数。默认情况下，它会在当前工作目录的 hack/config.yaml 或者框架默认的配置路径下寻找配置文件。

配置文件的结构如下（以 config.yaml 为例）：

gfcli:
  gen:
    dao:
      - link: "mysql:root:password@tcp(127.0.0.1:3306)/dbname"
        tables: "table1,table2"
        removePrefix: "gf_"
        descriptionTag: true
        noModelComment: false
  docker:
    build:
      "-a": "amd64"
      "-s": "linux"
      "-p": "temp"
    tagPrefixes:
      - "registry.example.com/"
      - "ghcr.io/myorg/"

上述配置文件包含两部分：gen 和 docker，分别对应 gf gen 和 gf docker build 命令的设置。您可以根据实际需求调整这些值，以便在执行命令时自动应用它们。

请注意，如果命令行参数存在，则命令行参数优先于配置文件中的设定。可以通过修改配置文件来改变默认行为，或在命令行中指定不同的参数覆盖默认设置。

更多关于 GoFrame CLI 的详细信息和用法，请查阅项目官方文档和命令行帮助。

gf-cliGoFrame Command Line Interface, which is your helpmate for building GoFrame application with convenience.项目地址:https://gitcode.com/gh_mirrors/gf/gf-cli