# goframe-skill

**Repository Path**: wiseai/goframe-skill

## Basic Information

- **Project Name**: goframe-skill
- **Description**: 使用book-to-skill创建的goframe技能
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-09-18
- **Last Updated**: 2026-09-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# goframe-skill

GoFrame 框架完整知识库技能（Agent Skill）。涵盖框架文档、工程规范、代码生成、实践示例，供 GitHub Copilot CLI / Amp / Codex / Claude Code 等 Agent 宿主使用。

## 简介

本仓库是 GoFrame v2 框架的完整 Agent 技能包，将官方文档与实战工程规范整合为结构化知识库，帮助 AI 编码助手在 GoFrame 项目开发中提供准确、规范的辅助。

**版本**: GoFrame 2.10.x | **章节**: 15 | **参考文档**: 401 篇 | **示例项目**: 560 个文件

## 安装

使用 `skills` CLI 从任意 Agent 宿主安装：

```bash
npx skills add https://gitee.com/wiseai/goframe-skill.git --skill goframe_doc
```

或手动将本仓库内容放置到宿主技能目录（如 `~/.agents/skills/goframe_doc/`、`~/.config/opencode/skills/goframe_doc/`）。

## 文件清单

```
├── SKILL.md              # 技能入口：工程规范 + 核心框架 + 15章索引
├── chapters/             # 15 个章节摘要（按需加载）
│   ├── ch01  CLI 开发工具
│   ├── ch02  命令管理
│   ├── ch03  配置管理
│   ├── ch04  日志组件
│   ├── ch05  数据库 ORM
│   ├── ch06  Web 服务
│   ├── ch07  缓存管理
│   ├── ch08  数据校验
│   ├── ch09  模板引擎
│   ├── ch10  会话管理
│   ├── ch11  国际化
│   ├── ch12  工具模块
│   ├── ch13  错误处理
│   ├── ch14  类型转换
│   └── ch15  项目脚手架
├── glossary.md           # 术语表
├── patterns.md           # 设计模式与最佳实践
├── cheatsheet.md         # 快速参考表
├── references/           # GoFrame 官方参考文档（按类别组织）
└── examples/             # 实际代码示例（HTTP/gRPC 等项目）
```

## 核心工程规范

技能内置以下 GoFrame 关键工程规范：

- **数据库操作必须使用 DO 对象**（`internal/model/do/`），禁止使用 `g.Map`
- **软删除与时间维护**：`created_at`/`updated_at`/`deleted_at` 由 ORM 自动处理，勿手动设置
- **错误处理**：统一使用 `gerror` 组件，用 `%+v` 打印完整堆栈
- **代码生成**：`gf gen dao/ctrl` 自动生成的代码文件不得手动修改
- **项目结构**：`gf init` 创建脚手架，业务逻辑放 `service/` 目录

## 使用方式

- 询问 `goframe_doc` → 加载核心框架与工程规范
- 询问 `goframe_doc 关于 错误处理` → 查找并解释主题
- 询问 `goframe_doc ch05` → 深入特定章节
- 询问官方文档具体话题 → 在 `references/` 中查找引用

## 说明

本仓库内容为 GoFrame 官方文档的整理与工程规范的提炼，用于 Agent 辅助开发。章节为合成摘要，参考文档与示例来自 GoFrame 官方开源项目（MIT 许可）。

## 相关资源

- [GoFrame 官方文档](https://goframe.org)
- [GoFrame 源码](https://github.com/gogf/gf)