All skills
gogf avatar

/goframe-v2

@911705d
by GoFramegogf/skills81 stars
3

GoFrame v2 development skill. Use only when the target Go project uses or is explicitly adopting GoFrame v2: the nearest go.mod requires github.com/gogf/gf/v2, existing Go files import github.com/gogf/gf/v2 or any github.com/gogf/gf/v2/... component package, or the user asks to scaffold, migrate, or build with GoFrame. Trigger for GoFrame-backed Go work such as APIs/controllers/services, middleware, routing/config, ORM/DAO/DO/entity/database operations, gf CLI/codegen, HTTP/gRPC services, and microservice conventions. Do not trigger for generic Go projects without GoFrame evidence, frontend-only work, shell scripts, or unrelated infrastructure tasks.

Use this Skill: https://skilld.dev/gh/gogf/skills/goframe-v2

This session only. Nothing lands on disk.

references核心组件命令管理命令管理-基本概念.md

基本概念

参数(Argument)

程序命令行按照顺序进行传递、没有名称标识的数据叫做参数(Argument),参数的输入具有顺序性。

选项(Option)

控制程序逻辑的附加输入、并且具有名称标识的数据叫做选项(Options),选项名称以-或者--字符串作为前缀,选项是无序的,可以放置于命令行中任意位置。选项可以带有数据,也可以不带数据。在其他类似的第三方功能组件里面,选项的功能类似于标识(Flag)。

此外,根据传统的命令行管理习惯,选项可以设置缩写别名(Short),用于简化命令行参数输入。缩写别名往往设定为一个单字母。

选项位置与 = 号

gcmd 组件支持选项的位置在命令行中是任意的,也就是说,以下命令行选项输入其实意义是一样的:

gf build main.go -a amd64 -o linux -n app -yes
gf -a amd64 -o linux build main.go -yes -n app
gf -yes -n app build -o linux -a amd64 main.go

其中,

  • gf/build/main.go 是参数,索引分别为 0、1、2;因为参数是有序性的,因此无论命令行怎么修改,这三者的顺序却无法改变
  • a/o/n 是带有数据的选项,由于是顺序无关的,通过选项名称获取数据,因此可以随意放置位置
  • yes 是不带数据的选项,也可以随意放置位置

命令行的选项与数据之间可以通过空格,也可以通过 = 符号进行连接,如:

gf build main.go -a=amd64 -o=linux -n=app -yes

默认解析规则

由于 gcmd 模块提供了一些包方法用以获取默认的命令行解析规则。在默认规则下,将会自动识别参数与选项。

命令行中带有 = 符号的场景下

gf build main.go -a=amd64 -o=linux -n=app -yes

在默认规则下,

  • gf/ build/ main.go 是参数,索引分别为 0, 1, 2。
  • a/ o/ n/ yes 将会被解析为选项,并且 yes 为无数据选项。

不使用 = 符号来连接选项参数

gf build main.go -a amd64 -o linux -n app -yes

在默认规则下,

  • gf/ build/ main.go 是参数,索引分别为 0, 1, 2。
  • a/ o/ n/ yes 将会被解析为选项,并且 yes 为无数据选项。

Source: SKILL.md on GitHub

1 alert16d5 checks · Risk MEDIUM
  • Gen Agent Trust Hub16d

    The skill provides a comprehensive development guide and code examples for the GoFrame v2 framework. While highly informative for Go developers, it contains several examples with hardcoded placeholder secrets, tokens, and specific local file paths to sensitive configuration files (like Kubernetes credentials). These elements are provided for demonstration purposes but represent insecure practices if used in production without modification.

  • Socket16d

    5 alerts: gptSecurity, gptAnomaly

  • Snyk16d

    Risk: LOW · No issues

  • Runlayer6mo

    227/949 files flagged

  • ZeroLeaks5mo

    Score: 93/100 · 2 sections analyzed

Signed by skilld at 911705d. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 4 months ago.

Steadyupdated 4 months ago
  • Go
  • Database
  • goframe
  • orm
  • http
  • grpc
  • microservices
  • crud
  • scaffolding
  • middleware

README badge

README badge for gogf/skills

Provides instruction and conventions for developing with GoFrame v2, a modular Go framework for building HTTP and gRPC services, microservices, and database operations using its ORM, CLI tooling, and project scaffolding. Use this skill when the target project has GoFrame v2 as a dependency or when the user requests scaffolding, migrations, or service development with GoFrame conventions.

Generated from the current SKILL.md.

When should I use this skill?
Use this skill only when your Go project uses GoFrame v2, indicated by github.com/gogf/gf/v2 in go.mod or imports. Do not use for generic Go projects, frontend work, or infrastructure tasks unrelated to GoFrame.
Should I manually set created_at and updated_at fields?
No. GoFrame automatically writes created_at on insert and updated_at on insert/update/save. Manually setting these fields is redundant and violates project conventions.
What should I use for database operations instead of g.Map?
Always use DO objects from internal/model/do/. DO struct fields are interface{}, unset fields remain nil and are automatically ignored by the ORM.
How does soft delete work in GoFrame?
Call Delete() on the DAO; GoFrame automatically converts it to UPDATE SET deleted_at = NOW(). Queries automatically filter out soft-deleted rows without requiring manual WhereNull conditions.
Where should I implement business logic?
Implement business logic directly in the service/ directory. Do not use the logic/ directory unless explicitly requested.

Generated from the current SKILL.md. These answers refresh after source changes.