# Awesome CodeBuddy > 这里是我们通过实践和收集沉淀的Agents/Commands/Skills/Hooks的集合(持续更新中)，用于帮助团队共享和提升开发效率。 ## 目录 - [内容介绍](#内容介绍) - [项目结构](#项目结构) - [快速开始](#快速开始) - [核心组件](#核心组件) - [Subagents - 专业AI助手](#Subagents---专业AI助手) - [Commands - 自动化命令](#commands---自动化命令) - [Skills - 技能扩展](#skills---技能扩展) - [详细使用指南](#详细使用指南) - [配置文件说明](#配置文件说明) - [环境与依赖](#环境与依赖) - [常见问题](#常见问题) - [维护与合规](#维护与合规) ## 内容介绍 本项目的内容包含： - **6 个专业 Subagents** - 涵盖前端开发、架构设计、代码审查、调试、测试等场景 - ️ **3 个自动化 Commands** - 一键执行代码审查、API文档生成、测试生成 - **1 个专业 Skill** - Web应用测试完整教程（Playwright + 9个渐进式示例） - **1 套开发规范** - 磐石后端接口开发规范（包含接口命名、字段规范、错误码等） ## 项目结构 \`\`\` awesome-codebuddy/ ├── .codebuddy/ # 核心配置目录 │ ├── agents/ # AI 助手定义 │ │ ├── frontend-developer.md # 前端开发者（React/Next.js + Vue 3） │ │ ├── backend-architect.md # 后端架构师 │ │ ├── code-reviewer.md # 代码审查专家 │ │ ├── data-scientist.md # 数据分析师 │ │ ├── debugger.md # 调试专家 │ │ └── test-automator.md # 测试自动化 │ ├── commands/ # 自动化命令 │ │ ├── code-review.md # 代码审查命令 │ │ ├── generate-api-doc.md # API文档生成 │ │ └── generate-tests.md # 测试生成命令 │ ├── skills/ # 技能扩展 │ │ └── webapp-testing/ # Web应用测试技能 │ │ ├── SKILL.md # Skill定义 │ │ ├── examples/ # 示例代码 │ │ │ └── tutorial/ # 完整教程（9个示例） │ │ └── scripts/ # 辅助脚本 │ └── rules/ # rules目录 │ └── api-standards.md # 前后端接口开发规范 ├── CODEBUDDY.md # 项目配置模板 ├── CODEBUDDY_global.md # 全局配置参考 ├── CODEBUDDY_MD_guidelines.md # 配置编写指南（文件名包含空格） ├── KM.md # 知识管理最佳实践 └── README.md # 本文档 \`\`\` ## 快速开始 ### 前置要求 - **Node.js ≥ 16** - 运行命令与相关工具 - **CodeBuddy Code** - 安装 \`npm install -g @tencent-ai/codebuddy-code\` - **Git** - 用于克隆仓库 ### 30秒快速安装 \`\`\`bash # 1. 克隆仓库 git clone https://git.woa.com/CloudBusinessManage/awesome-codebuddy cd awesome-codebuddy # 2. 复制配置到你的项目 cp -r .codebuddy /path/to/your/project/ # 3. 开始使用 cd /path/to/your/project # 在 CodeBuddy Code 中就可以使用了！ \`\`\` ## 核心组件 ### Subagents - 专业AI助手 | Agent | 描述 | 使用方法 | |-------|------|----------| | **frontend-developer** | 前端开发专家（React/Next.js + Vue 3） | \`@frontend-developer 构建一个可复用的分页表格组件\` | | **backend-architect** | 后端架构和API设计专家 | \`@backend-architect 设计用户认证服务\` | | **code-reviewer** | 深度代码审查专家 | \`@code-reviewer 审查最近的提交\` | | **data-scientist** | 数据分析和SQL优化 | \`@data-scientist 优化这个查询\` | | **debugger** | Bug定位和修复专家 | \`@debugger 分析这个错误\` | | **test-automator** | 自动生成测试用例 | \`@test-automator 为这个文件生成测试\` | #### 使用示例：Backend Architect \`\`\` 用户: @backend-architect 为电商系统设计订单服务API 助手将会: 设计RESTful API端点 提供请求/响应示例 生成架构图(Mermaid格式) 设计数据库表结构 给出技术选型建议 分析潜在性能瓶颈 \`\`\` ### Commands - 自动化命令 | Command | 功能 | 使用示例 | |---------|------|---------| | **/code-review** | 全面代码审查(质量、安全、性能) | \`/code-review --full\` | | **/generate-api-doc** | 自动生成API文档 | \`/generate-api-doc --markdown\` | | **/generate-tests** | 生成测试套件 | \`/generate-tests handler.go\` | #### 使用示例：代码审查 \`\`\`bash /code-review --full # 输出内容包括: # 代码质量问题 # 安全漏洞检查 # 性能瓶颈分析 # 架构设计评估 # 测试覆盖率建议 \`\`\` ### Skills - 技能扩展 #### webapp-testing - Web应用测试技能 **完整的 Playwright 自动化测试教程**，从入门到精通，包含9个渐进式示例。 **特色：** - **开箱即用** - 所有示例都可直接运行 - **渐进式学习** - 从静态HTML到复杂SPA，循序渐进 - **配套练习** - 每个示例都有练习题和FAQ - **便捷命令** - 使用 Makefile 一键运行所有示例 - **中文文档** - 1200+行详细中文教程 **学习路径：** **入门级** (1小时) - 01 - 静态HTML测试 - 02 - 元素发现 - 03 - 截图测试 **中级** (1.5小时) - 04 - 表单自动化 - 05 - 动态内容测试 ⭐ - 06 - 控制台调试 **高级** (2小时) - 07 - SPA测试 - 08 - 服务器集成测试 - 09 - 综合测试套件 ⭐ **快速开始：** \`\`\`bash # 1. 进入教程目录 cd .codebuddy/skills/webapp-testing/examples/tutorial # 2. 查看所有可用命令 make help # 3. 运行第一个示例 make 01 # 4. 运行所有示例 make all \`\`\` **学到什么：** - 使用 Playwright 进行浏览器自动化 - 处理动态内容和等待策略 - 表单自动化填写和提交 - 捕获截图和控制台日志 - 测试单页应用（SPA） - 前后端集成测试 - 编写完整的测试套件 **环境要求：** \`\`\`bash pip install playwright playwright install chromium \`\`\` 详细教程请查看：[webapp-testing 完整教程](.codebuddy/skills/webapp-testing/examples/tutorial/README.md) ## 详细使用指南 ### 场景一：架构设计 \`\`\`bash # 场景：设计微服务架构 @backend-architect 设计一个订单管理微服务，包含下单、支付、发货功能 # 你会得到： # 1. API端点设计和接口定义 # 2. 数据库表结构设计 # 3. 服务间通信方案 # 4. 缓存和消息队列设计 # 5. 架构图(Mermaid格式) \`\`\` ### 场景二：代码审查 \`\`\`bash # 场景：全面审查项目代码 /code-review --full # 审查内容： # - 代码质量（命名、复杂度、重复代码） # - 安全漏洞（SQL注入、XSS、认证问题） # - 性能问题（N+1查询、内存泄漏） # - 架构设计（耦合度、可扩展性） # - 测试覆盖（缺失测试、测试质量） \`\`\` ### 场景三：自动化测试 \`\`\`bash # 场景1：生成单元测试 @test-automator 为 user_service.go 生成单元测试 \`\`\` ### 场景四：调试排错 \`\`\`bash # 场景：分析运行时错误 @debugger 分析这个panic错误：runtime error: index out of range [3] with length 2 # 你会得到： # 1. 错误原因分析 # 2. 可能的触发条件 # 3. 修复建议 # 4. 预防措施 \`\`\` ### 场景五：Web应用自动化测试 \`\`\`bash # 场景：学习 Playwright 自动化测试 cd .codebuddy/skills/webapp-testing/examples/tutorial # 运行完整学习路径 make all # 或按需学习： make 01 # 静态HTML测试（入门） make 05 # 动态内容测试（重点⭐） make 09 # 综合测试套件（实战⭐） # 你会学到： # 浏览器自动化基础 # 元素查找和操作 # 动态内容等待策略（关键！） # 表单自动化填写 # 截图和日志捕获 # SPA应用测试 # 前后端集成测试 # 完整测试套件编写 \`\`\` ## 配置文件说明 ### 核心配置文件 | 文件 | 用途 | 何时使用 | |------|------|----------| | **CODEBUDDY.md** | 项目配置模板 | 定制项目专属的AI助手行为 | | **CODEBUDDY_global.md** | 全局配置示例 | 设置个人偏好的全局配置 | | **CODEBUDDY_MD_ guidelines.md** | 配置编写指南 | 学习如何编写高质量配置 | | **agent_template.md** | Agent创建模板 | 创建自定义Agent | | **KM.md** | 知识管理最佳实践 | 了解高级配置技巧 | ### 如何定制你的配置 #### 1. 选择性复制组件 \`\`\`bash # 只复制你需要的agents cp .codebuddy/agents/backend-architect.md /your/project/.codebuddy/agents/ # 只复制你需要的commands cp .codebuddy/commands/code-review.md /your/project/.codebuddy/commands/ \`\`\` #### 2. 修改配置适配你的技术栈 \`\`\`markdown # 编辑 backend-architect.md # 将 "tRPC-Go" 改为你的框架（如 Spring Boot、Django等） # 调整代码规范和最佳实践 \`\`\` #### 3. 创建项目专属配置 \`\`\`bash # 复制并编辑CODEBUDDY.md cp CODEBUDDY.md /your/project/ # 编辑文件，添加你的项目特定信息： # - 技术栈 # - 编码规范 # - 团队约定 \`\`\` ## 环境与依赖 | 组件 | 版本建议 | 备注 | |------|----------|------| | Node.js | ≥ 16 | 推荐 LTS 版本 | | CodeBuddy Code | 最新 | \`npm install -g @tencent-ai/codebuddy-code\` | 网络提示：内网环境如遇依赖下载慢，可切换公司镜像或预装依赖。 ## 常见问题 - 命令不可用：确认已安装 CodeBuddy Code 并已在 PATH 中；重新打开终端。 - 端口占用：将 \`--port\` 改为未占用端口（如 5173/8080）。 - 权限不足：macOS 可能需要 \`chmod +x\` 脚本或授予执行权限。 - 内部网络限制：使用公司内网镜像或联系平台支持获取离线安装指引。 ## 维护与合规 - 使用范围：仅供公司内部使用，勿提交或传播包含敏感数据的内容。 - 数据合规：请遵循公司数据分级与最小必要原则，勿上传生产数据。 - 维护人：请在此处补充模块维护人/群（示例：代码平台团队）。