diff --git a/docs/zh-CN/CONTRIBUTING.md b/docs/zh-CN/CONTRIBUTING.md index 47d5fee..9ad06e0 100644 --- a/docs/zh-CN/CONTRIBUTING.md +++ b/docs/zh-CN/CONTRIBUTING.md @@ -1,6 +1,18 @@ # 为 Everything Claude Code 做贡献 -感谢您希望做出贡献。这个仓库旨在成为 Claude Code 用户的社区资源。 +感谢您想要贡献！这个仓库是 Claude Code 用户的社区资源。 + +## 目录 + +* [我们正在寻找的内容](#我们寻找什么) +* [快速开始](#快速开始) +* [贡献技能](#贡献技能) +* [贡献智能体](#贡献智能体) +* [贡献钩子](#贡献钩子) +* [贡献命令](#贡献命令) +* [拉取请求流程](#拉取请求流程) + +*** ## 我们寻找什么 @@ -21,16 +33,6 @@ * 框架模式 * 测试策略 * 架构指南 -* 领域特定知识 - -### 命令 - -调用有用工作流的斜杠命令： - -* 部署命令 -* 测试命令 -* 文档命令 -* 代码生成命令 ### 钩子 @@ -41,124 +43,365 @@ * 验证钩子 * 通知钩子 -### 规则 +### 命令 -始终遵循的指导原则： +调用有用工作流的斜杠命令： -* 安全规则 -* 代码风格规则 -* 测试要求 -* 命名约定 - -### MCP 配置 - -新的或改进的 MCP 服务器配置： - -* 数据库集成 -* 云提供商 MCP -* 监控工具 -* 通讯工具 +* 部署命令 +* 测试命令 +* 代码生成命令 *** -## 如何贡献 - -### 1. Fork 仓库 +## 快速开始 ```bash -git clone https://github.com/YOUR_USERNAME/everything-claude-code.git +# 1. Fork and clone +gh repo fork affaan-m/everything-claude-code --clone cd everything-claude-code + +# 2. Create a branch +git checkout -b feat/my-contribution + +# 3. Add your contribution (see sections below) + +# 4. Test locally +cp -r skills/my-skill ~/.claude/skills/ # for skills +# Then test with Claude Code + +# 5. Submit PR +git add . && git commit -m "feat: add my-skill" && git push ``` -### 2. 创建一个分支 +*** -```bash -git checkout -b add-python-reviewer +## 贡献技能 + +技能是 Claude Code 根据上下文加载的知识模块。 + +### 目录结构 + +``` +skills/ +└── your-skill-name/ + └── SKILL.md ``` -### 3. 添加您的贡献 - -将文件放在适当的目录中： - -* `agents/` 用于新的智能体 -* `skills/` 用于技能（可以是单个 .md 文件或目录） -* `commands/` 用于斜杠命令 -* `rules/` 用于规则文件 -* `hooks/` 用于钩子配置 -* `mcp-configs/` 用于 MCP 服务器配置 - -### 4. 遵循格式 - -**智能体** 应包含 frontmatter： +### SKILL.md 模板 ```markdown --- -name: agent-name -description: What it does -tools: Read, Grep, Glob, Bash +name: your-skill-name +description: Brief description shown in skill list +--- + +# 你的技能标题 + +简要概述此技能涵盖的内容。 + +## 核心概念 + +解释关键模式和准则。 + +## 代码示例 + +`​`​`typescript + +// 包含实用、经过测试的示例 +function example() { + // 注释良好的代码 +} +`​`​` + + +## 最佳实践 + +- 可操作的指导原则 +- 该做与不该做的事项 +- 需要避免的常见陷阱 + +## 适用场景 + +描述此技能适用的场景。 + +``` + +### 技能清单 + +* \[ ] 专注于一个领域/技术 +* \[ ] 包含实用的代码示例 +* \[ ] 少于 500 行 +* \[ ] 使用清晰的章节标题 +* \[ ] 已通过 Claude Code 测试 + +### 技能示例 + +| 技能 | 目的 | +|-------|---------| +| `coding-standards/` | TypeScript/JavaScript 模式 | +| `frontend-patterns/` | React 和 Next.js 最佳实践 | +| `backend-patterns/` | API 和数据库模式 | +| `security-review/` | 安全检查清单 | + +*** + +## 贡献智能体 + +智能体是通过任务工具调用的专业助手。 + +### 文件位置 + +``` +agents/your-agent-name.md +``` + +### 智能体模板 + +```markdown +--- +name: 你的代理名称 +description: 该代理的作用以及 Claude 应在何时调用它。请具体说明！ +tools: ["Read", "Write", "Edit", "Bash", "Grep", "Glob"] model: sonnet --- -Instructions here... +你是一名 [角色] 专家。 + +## 你的角色 + +- 主要职责 +- 次要职责 +- 你不做的事情（界限） + +## 工作流程 + +### 步骤 1：理解 +你如何着手处理任务。 + +### 步骤 2：执行 +你如何开展工作。 + +### 步骤 3：验证 +你如何验证结果。 + +## 输出格式 + +你返回给用户的内容。 + +## 示例 + +### 示例：[场景] +输入：[用户提供的内容] +操作：[你做了什么] +输出：[你返回的内容] + ``` -**技能** 应清晰且可操作： +### 智能体字段 -```markdown -# Skill Name +| 字段 | 描述 | 选项 | +|-------|-------------|---------| +| `name` | 小写，用连字符连接 | `code-reviewer` | +| `description` | 用于决定何时调用 | 要具体！ | +| `tools` | 仅包含必要的内容 | `Read, Write, Edit, Bash, Grep, Glob, WebFetch, Task` | +| `model` | 复杂度级别 | `haiku` (简单), `sonnet` (编码), `opus` (复杂) | -## When to Use +### 智能体示例 -... +| 智能体 | 目的 | +|-------|---------| +| `tdd-guide.md` | 测试驱动开发 | +| `code-reviewer.md` | 代码审查 | +| `security-reviewer.md` | 安全扫描 | +| `build-error-resolver.md` | 修复构建错误 | -## How It Works +*** -... +## 贡献钩子 -## Examples +钩子是由 Claude Code 事件触发的自动行为。 -... +### 文件位置 + +``` +hooks/hooks.json ``` -**命令** 应解释其功能： +### 钩子类型 -```markdown ---- -description: Brief description of command ---- +| 类型 | 触发条件 | 用例 | +|------|---------|----------| +| `PreToolUse` | 工具运行前 | 验证、警告、阻止 | +| `PostToolUse` | 工具运行后 | 格式化、检查、通知 | +| `SessionStart` | 会话开始时 | 加载上下文 | +| `Stop` | 会话结束时 | 清理、审计 | -# Command Name - -Detailed instructions... -``` - -**钩子** 应包含描述： +### 钩子格式 ```json { - "matcher": "...", - "hooks": [...], - "description": "What this hook does" + "hooks": { + "PreToolUse": [ + { + "matcher": "tool == \"Bash\" && tool_input.command matches \"rm -rf /\"", + "hooks": [ + { + "type": "command", + "command": "echo '[Hook] BLOCKED: Dangerous command' && exit 1" + } + ], + "description": "Block dangerous rm commands" + } + ] + } } ``` -### 5. 测试您的贡献 +### 匹配器语法 -在提交之前，请确保您的配置能在 Claude Code 中正常工作。 +```javascript +// Match specific tools +tool == "Bash" +tool == "Edit" +tool == "Write" -### 6. 提交 PR +// Match input patterns +tool_input.command matches "npm install" +tool_input.file_path matches "\\.tsx?$" -```bash -git add . -git commit -m "Add Python code reviewer agent" -git push origin add-python-reviewer +// Combine conditions +tool == "Bash" && tool_input.command matches "git push" ``` -然后提交一个 PR，包含以下内容： +### 钩子示例 -* 您添加了什么 -* 为什么它有用 -* 您是如何测试的 +```json +// Block dev servers outside tmux +{ + "matcher": "tool == \"Bash\" && tool_input.command matches \"npm run dev\"", + "hooks": [{"type": "command", "command": "echo 'Use tmux for dev servers' && exit 1"}], + "description": "Ensure dev servers run in tmux" +} + +// Auto-format after editing TypeScript +{ + "matcher": "tool == \"Edit\" && tool_input.file_path matches \"\\.tsx?$\"", + "hooks": [{"type": "command", "command": "npx prettier --write \"$file_path\""}], + "description": "Format TypeScript files after edit" +} + +// Warn before git push +{ + "matcher": "tool == \"Bash\" && tool_input.command matches \"git push\"", + "hooks": [{"type": "command", "command": "echo '[Hook] Review changes before pushing'"}], + "description": "Reminder to review before push" +} +``` + +### 钩子清单 + +* \[ ] 匹配器具体（不过于宽泛） +* \[ ] 包含清晰的错误/信息消息 +* \[ ] 使用正确的退出代码 (`exit 1` 阻止, `exit 0` 允许) +* \[ ] 经过充分测试 +* \[ ] 有描述 + +*** + +## 贡献命令 + +命令是用户通过 `/command-name` 调用的操作。 + +### 文件位置 + +``` +commands/your-command.md +``` + +### 命令模板 + +```markdown +--- +description: 在 /help 中显示的简要描述 +--- + +# 命令名称 + +## 目的 + +此命令的功能。 + +## 用法 + +`​`​` + +/your-command [args] +`​`​` + + +## 工作流程 + +1. 第一步 +2. 第二步 +3. 最后一步 + +## 输出 + +用户将收到的内容。 + +``` + +### 命令示例 + +| 命令 | 目的 | +|---------|---------| +| `commit.md` | 创建 git 提交 | +| `code-review.md` | 审查代码变更 | +| `tdd.md` | TDD 工作流 | +| `e2e.md` | E2E 测试 | + +*** + +## 拉取请求流程 + +### 1. PR 标题格式 + +``` +feat(skills): add rust-patterns skill +feat(agents): add api-designer agent +feat(hooks): add auto-format hook +fix(skills): update React patterns +docs: improve contributing guide +``` + +### 2. PR 描述 + +```markdown +## 摘要 +你正在添加什么以及为什么添加。 + +## 类型 +- [ ] 技能 +- [ ] 代理 +- [ ] 钩子 +- [ ] 命令 + +## 测试 +你是如何测试这个的。 + +## 检查清单 +- [ ] 遵循格式指南 +- [ ] 已使用 Claude Code 进行测试 +- [ ] 无敏感信息（API 密钥、路径） +- [ ] 描述清晰 + +``` + +### 3. 审查流程 + +1. 维护者在 48 小时内审查 +2. 如有要求，请处理反馈 +3. 一旦批准，合并到主分支 *** @@ -166,34 +409,34 @@ git push origin add-python-reviewer ### 应该做的 -* 保持配置专注且模块化 +* 保持贡献内容专注和模块化 * 包含清晰的描述 * 提交前进行测试 * 遵循现有模式 -* 记录任何依赖项 +* 记录依赖项 ### 不应该做的 * 包含敏感数据（API 密钥、令牌、路径） * 添加过于复杂或小众的配置 -* 提交未经测试的配置 -* 创建重复的功能 -* 添加需要特定付费服务且没有替代方案的配置 +* 提交未经测试的贡献 +* 创建现有功能的重复项 *** ## 文件命名 -* 使用小写字母和连字符：`python-reviewer.md` -* 要有描述性：`tdd-workflow.md` 而不是 `workflow.md` -* 确保智能体/技能名称与文件名匹配 +* 使用小写和连字符：`python-reviewer.md` +* 描述性要强：`tdd-workflow.md` 而不是 `workflow.md` +* 名称与文件名匹配 *** ## 有问题吗？ -请提出问题或在 X 上联系我们：[@affaanmustafa](https://x.com/affaanmustafa) +* **问题：** [github.com/affaan-m/everything-claude-code/issues](https://github.com/affaan-m/everything-claude-code/issues) +* **X/Twitter：** [@affaanmustafa](https://x.com/affaanmustafa) *** -感谢您的贡献。让我们共同构建一个优秀的资源。 +感谢您的贡献！让我们共同构建一个出色的资源。 diff --git a/docs/zh-CN/README.md b/docs/zh-CN/README.md index 8c5959a..8f2d508 100644 --- a/docs/zh-CN/README.md +++ b/docs/zh-CN/README.md @@ -1,21 +1,27 @@ -**语言:** English | [繁體中文](docs/zh-TW/README.md) | [简体中文](docs/zh-CN/README.md) +**语言:** English | [繁體中文](../zh-TW/README.md) | [简体中文](README.md) # Everything Claude Code [![Stars](https://img.shields.io/github/stars/affaan-m/everything-claude-code?style=flat)](https://github.com/affaan-m/everything-claude-code/stargazers) +[![Forks](https://img.shields.io/github/forks/affaan-m/everything-claude-code?style=flat)](https://github.com/affaan-m/everything-claude-code/network/members) +[![Contributors](https://img.shields.io/github/contributors/affaan-m/everything-claude-code?style=flat)](https://github.com/affaan-m/everything-claude-code/graphs/contributors) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE) ![Shell](https://img.shields.io/badge/-Shell-4EAA25?logo=gnu-bash\&logoColor=white) ![TypeScript](https://img.shields.io/badge/-TypeScript-3178C6?logo=typescript\&logoColor=white) +![Python](https://img.shields.io/badge/-Python-3776AB?logo=python\&logoColor=white) ![Go](https://img.shields.io/badge/-Go-00ADD8?logo=go\&logoColor=white) +![Java](https://img.shields.io/badge/-Java-ED8B00?logo=openjdk\&logoColor=white) ![Markdown](https://img.shields.io/badge/-Markdown-000000?logo=markdown\&logoColor=white) +> **42K+ 星标** | **5K+ 分支** | **24 位贡献者** | **支持 6 种语言** + ***
**🌐 语言 / 语言 / 語言** -[**English**](README.md) | [简体中文](README.zh-CN.md) | [繁體中文](docs/zh-TW/README.md) +[**English**](../../README.md) | [简体中文](../../README.zh-CN.md) | [繁體中文](../../docs/zh-TW/README.md)
@@ -61,6 +67,38 @@ *** +## 最新动态 + +### v1.4.1 — 错误修复 (2026年2月) + +* **修复了直觉导入内容丢失问题** — `parse_instinct_file()` 在 `/instinct-import` 期间会静默丢弃 frontmatter 之后的所有内容（Action, Evidence, Examples 部分）。已由社区贡献者 @ericcai0814 修复 ([#148](https://github.com/affaan-m/everything-claude-code/issues/148), [#161](https://github.com/affaan-m/everything-claude-code/pull/161)) + +### v1.4.0 — 多语言规则、安装向导 & PM2 (2026年2月) + +* **交互式安装向导** — 新的 `configure-ecc` 技能提供了带有合并/覆盖检测的引导式设置 +* **PM2 & 多智能体编排** — 6 个新命令 (`/pm2`, `/multi-plan`, `/multi-execute`, `/multi-backend`, `/multi-frontend`, `/multi-workflow`) 用于管理复杂的多服务工作流 +* **多语言规则架构** — 规则从扁平文件重组为 `common/` + `typescript/` + `python/` + `golang/` 目录。仅安装您需要的语言 +* **中文 (zh-CN) 翻译** — 所有智能体、命令、技能和规则的完整翻译 (80+ 个文件) +* **GitHub Sponsors 支持** — 通过 GitHub Sponsors 赞助项目 +* **增强的 CONTRIBUTING.md** — 针对每种贡献类型的详细 PR 模板 + +### v1.3.0 — OpenCode 插件支持 (2026年2月) + +* **完整的 OpenCode 集成** — 12 个智能体，24 个命令，16 个技能，通过 OpenCode 的插件系统支持钩子 (20+ 种事件类型) +* **3 个原生自定义工具** — run-tests, check-coverage, security-audit +* **LLM 文档** — `llms.txt` 用于获取全面的 OpenCode 文档 + +### v1.2.0 — 统一的命令和技能 (2026年2月) + +* **Python/Django 支持** — Django 模式、安全、TDD 和验证技能 +* **Java Spring Boot 技能** — Spring Boot 的模式、安全、TDD 和验证 +* **会话管理** — `/sessions` 命令用于查看会话历史 +* **持续学习 v2** — 基于直觉的学习，带有置信度评分、导入/导出、进化 + +完整的更新日志请参见 [Releases](https://github.com/affaan-m/everything-claude-code/releases)。 + +*** + ## 🚀 快速开始 在 2 分钟内启动并运行： @@ -83,8 +121,13 @@ # Clone the repo first git clone https://github.com/affaan-m/everything-claude-code.git -# Copy rules (applies to all projects) -cp -r everything-claude-code/rules/* ~/.claude/rules/ +# Install common rules (required) +cp -r everything-claude-code/rules/common/* ~/.claude/rules/ + +# Install language-specific rules (pick your stack) +cp -r everything-claude-code/rules/typescript/* ~/.claude/rules/ +cp -r everything-claude-code/rules/python/* ~/.claude/rules/ +cp -r everything-claude-code/rules/golang/* ~/.claude/rules/ ``` ### 步骤 3：开始使用 @@ -97,7 +140,7 @@ cp -r everything-claude-code/rules/* ~/.claude/rules/ /plugin list everything-claude-code@everything-claude-code ``` -✨ **就这样！** 您现在可以访问 15+ 个代理、30+ 个技能和 20+ 个命令。 +✨ **就是这样！** 您现在可以访问 15+ 个智能体，30+ 个技能，以及 30+ 个命令。 *** @@ -156,23 +199,38 @@ everything-claude-code/ | |-- e2e-runner.md # Playwright 端到端测试 | |-- refactor-cleaner.md # 无用代码清理 | |-- doc-updater.md # 文档同步 -| |-- go-reviewer.md # Go 代码审查（新增） -| |-- go-build-resolver.md # Go 构建错误修复（新增） +| |-- go-reviewer.md # Go 代码审查 +| |-- go-build-resolver.md # Go 构建错误修复 +| |-- python-reviewer.md # Python 代码审查（新增） +| |-- database-reviewer.md # 数据库/Supabase 审查（新增） | |-- skills/ # 工作流定义与领域知识 | |-- coding-standards/ # 各语言最佳实践 | |-- backend-patterns/ # API、数据库、缓存模式 | |-- frontend-patterns/ # React、Next.js 模式 | |-- continuous-learning/ # 从会话中自动提取模式（长文档指南） -| |-- continuous-learning-v2/ # 基于直觉的学习，带置信度评分 +| |-- continuous-learning-v2/ # 基于直觉的学习与置信度评分 | |-- iterative-retrieval/ # 子代理的渐进式上下文精炼 | |-- strategic-compact/ # 手动压缩建议（长文档指南） | |-- tdd-workflow/ # TDD 方法论 | |-- security-review/ # 安全检查清单 | |-- eval-harness/ # 验证循环评估（长文档指南） | |-- verification-loop/ # 持续验证（长文档指南） -| |-- golang-patterns/ # Go 语言习惯用法与最佳实践（新增） -| |-- golang-testing/ # Go 测试模式、TDD、基准测试（新增） +| |-- golang-patterns/ # Go 语言惯用法与最佳实践 +| |-- golang-testing/ # Go 测试模式、TDD 与基准测试 +| |-- cpp-testing/ # 使用 GoogleTest、CMake/CTest 的 C++ 测试（新增） +| |-- django-patterns/ # Django 模式、模型与视图（新增） +| |-- django-security/ # Django 安全最佳实践（新增） +| |-- django-tdd/ # Django TDD 工作流（新增） +| |-- django-verification/ # Django 验证循环（新增） +| |-- python-patterns/ # Python 惯用法与最佳实践（新增） +| |-- python-testing/ # 使用 pytest 的 Python 测试（新增） +| |-- springboot-patterns/ # Java Spring Boot 模式（新增） +| |-- springboot-security/ # Spring Boot 安全（新增） +| |-- springboot-tdd/ # Spring Boot TDD（新增） +| |-- springboot-verification/ # Spring Boot 验证流程（新增） +| |-- configure-ecc/ # 交互式安装向导（新增） +| |-- security-scan/ # AgentShield 安全审计集成（新增） | |-- commands/ # 快捷执行的 Slash 命令 | |-- tdd.md # /tdd - 测试驱动开发 @@ -192,15 +250,28 @@ everything-claude-code/ | |-- instinct-status.md # /instinct-status - 查看已学习的直觉（新增） | |-- instinct-import.md # /instinct-import - 导入直觉（新增） | |-- instinct-export.md # /instinct-export - 导出直觉（新增） -| |-- evolve.md # /evolve - 将直觉聚类为技能（新增） +| |-- evolve.md # /evolve - 将直觉聚类为技能 +| |-- pm2.md # /pm2 - PM2 服务生命周期管理（新增） +| |-- multi-plan.md # /multi-plan - 多代理任务拆解（新增） +| |-- multi-execute.md # /multi-execute - 编排式多代理工作流（新增） +| |-- multi-backend.md # /multi-backend - 后端多服务编排（新增） +| |-- multi-frontend.md # /multi-frontend - 前端多服务编排（新增） +| |-- multi-workflow.md # /multi-workflow - 通用多服务工作流（新增） | |-- rules/ # 必须遵循的规则（复制到 ~/.claude/rules/） -| |-- security.md # 强制安全检查 -| |-- coding-style.md # 不可变性、文件组织规范 -| |-- testing.md # TDD，80% 覆盖率要求 -| |-- git-workflow.md # 提交格式与 PR 流程 -| |-- agents.md # 何时委派给子代理 -| |-- performance.md # 模型选择与上下文管理 +| |-- README.md # 结构概览与安装指南 +| |-- common/ # 与语言无关的通用原则 +| | |-- coding-style.md # 不可变性与文件组织 +| | |-- git-workflow.md # 提交格式与 PR 流程 +| | |-- testing.md # TDD，80% 覆盖率要求 +| | |-- performance.md # 模型选择与上下文管理 +| | |-- patterns.md # 设计模式与项目骨架 +| | |-- hooks.md # Hook 架构与 TodoWrite +| | |-- agents.md # 何时委派给子代理 +| | |-- security.md # 强制安全检查 +| |-- typescript/ # TypeScript / JavaScript 专用 +| |-- python/ # Python 专用 +| |-- golang/ # Go 专用 | |-- hooks/ # 基于触发器的自动化 | |-- hooks.json # 所有 Hook 配置（PreToolUse、PostToolUse、Stop 等） @@ -209,7 +280,7 @@ everything-claude-code/ | |-- scripts/ # 跨平台 Node.js 脚本（新增） | |-- lib/ # 共享工具 -| | |-- utils.js # 跨平台文件 / 路径 / 系统工具 +| | |-- utils.js # 跨平台文件/路径/系统工具 | | |-- package-manager.js # 包管理器检测与选择 | |-- hooks/ # Hook 实现 | | |-- session-start.js # 会话开始时加载上下文 @@ -227,7 +298,7 @@ everything-claude-code/ |-- contexts/ # 动态系统提示注入上下文（长文档指南） | |-- dev.md # 开发模式上下文 | |-- review.md # 代码审查模式上下文 -| |-- research.md # 研究 / 探索模式上下文 +| |-- research.md # 研究/探索模式上下文 | |-- examples/ # 示例配置与会话 | |-- CLAUDE.md # 项目级配置示例 @@ -277,6 +348,30 @@ everything-claude-code/ * **Instinct 集合** - 用于 continuous-learning-v2 * **模式提取** - 从您的提交历史中学习 +### AgentShield — 安全审计器 + +扫描您的 Claude Code 配置，查找漏洞、错误配置和注入风险。 + +```bash +# Quick scan (no install needed) +npx ecc-agentshield scan + +# Auto-fix safe issues +npx ecc-agentshield scan --fix + +# Deep analysis with Opus 4.6 +npx ecc-agentshield scan --opus --stream + +# Generate secure config from scratch +npx ecc-agentshield init +``` + +检查 CLAUDE.md、settings.json、MCP 服务器、钩子和智能体定义。生成带有可操作发现的安全等级 (A-F)。 + +在 Claude Code 中使用 `/security-scan` 来运行它，或者通过 [GitHub Action](https://github.com/affaan-m/agentshield) 添加到 CI。 + +[GitHub](https://github.com/affaan-m/agentshield) | [npm](https://www.npmjs.com/package/ecc-agentshield) + ### 🧠 持续学习 v2 基于本能的学习系统会自动学习您的模式： @@ -361,11 +456,15 @@ Duplicate hooks file detected: ./hooks/hooks.json resolves to already-loaded fil > git clone https://github.com/affaan-m/everything-claude-code.git > > # 选项 A：用户级规则（适用于所有项目） -> cp -r everything-claude-code/rules/* ~/.claude/rules/ +> cp -r everything-claude-code/rules/common/* ~/.claude/rules/ +> cp -r everything-claude-code/rules/typescript/* ~/.claude/rules/ # 选择您的技术栈 +> cp -r everything-claude-code/rules/python/* ~/.claude/rules/ +> cp -r everything-claude-code/rules/golang/* ~/.claude/rules/ > > # 选项 B：项目级规则（仅适用于当前项目） > mkdir -p .claude/rules -> cp -r everything-claude-code/rules/* .claude/rules/ +> cp -r everything-claude-code/rules/common/* .claude/rules/ +> cp -r everything-claude-code/rules/typescript/* .claude/rules/ # 选择您的技术栈 > ``` *** @@ -381,8 +480,11 @@ git clone https://github.com/affaan-m/everything-claude-code.git # Copy agents to your Claude config cp everything-claude-code/agents/*.md ~/.claude/agents/ -# Copy rules -cp everything-claude-code/rules/*.md ~/.claude/rules/ +# Copy rules (common + language-specific) +cp -r everything-claude-code/rules/common/* ~/.claude/rules/ +cp -r everything-claude-code/rules/typescript/* ~/.claude/rules/ # pick your stack +cp -r everything-claude-code/rules/python/* ~/.claude/rules/ +cp -r everything-claude-code/rules/golang/* ~/.claude/rules/ # Copy commands cp everything-claude-code/commands/*.md ~/.claude/commands/ @@ -451,15 +553,18 @@ model: opus ### 规则 -规则是始终遵循的指导原则。保持其模块化： +规则是始终遵循的指导原则，组织成 `common/`（与语言无关）+ 语言特定目录： ``` -~/.claude/rules/ - security.md # No hardcoded secrets - coding-style.md # Immutability, file limits - testing.md # TDD, coverage requirements +rules/ + common/ # Universal principles (always install) + typescript/ # TS/JS specific patterns and tools + python/ # Python specific patterns and tools + golang/ # Go specific patterns and tools ``` +有关安装和结构详情，请参阅 [`rules/README.md`](rules/README.md)。 + *** ## 🧪 运行测试 @@ -493,11 +598,144 @@ node tests/hooks/hooks.test.js ### 贡献想法 -* 特定语言的技能（Python、Rust 模式）- 现已包含 Go！ -* 特定框架的配置（Django、Rails、Laravel） -* DevOps 代理（Kubernetes、Terraform、AWS） -* 测试策略（不同框架） -* 特定领域的知识（ML、数据工程、移动开发） +* 特定语言技能 (Rust, C#, Swift, Kotlin) — Go, Python, Java 已包含 +* 特定框架配置 (Rails, Laravel, FastAPI, NestJS) — Django, Spring Boot 已包含 +* DevOps 智能体 (Kubernetes, Terraform, AWS, Docker) +* 测试策略 (不同框架，视觉回归) +* 领域特定知识 (ML, 数据工程, 移动端) + +*** + +## Cursor IDE 支持 + +ecc-universal 包含为 [Cursor IDE](https://cursor.com) 预翻译的配置。`.cursor/` 目录包含适用于 Cursor 格式的规则、智能体、技能、命令和 MCP 配置。 + +### 快速开始 (Cursor) + +```bash +# Install the package +npm install ecc-universal + +# Install for your language(s) +./install.sh --target cursor typescript +./install.sh --target cursor python golang +``` + +### 已翻译内容 + +| 组件 | Claude Code → Cursor | 对等性 | +|-----------|---------------------|--------| +| 规则 | 添加了 YAML frontmatter，路径扁平化 | 完全 | +| 智能体 | 模型 ID 已扩展，工具 → 只读标志 | 完全 | +| 技能 | 无需更改 (标准相同) | 相同 | +| 命令 | 路径引用已更新，多-\* 已存根 | 部分 | +| MCP 配置 | 环境变量插值语法已更新 | 完全 | +| 钩子 | Cursor 中无等效项 | 参见替代方案 | + +详情请参阅 [.cursor/README.md](.cursor/README.md)，完整迁移指南请参阅 [.cursor/MIGRATION.md](.cursor/MIGRATION.md)。 + +*** + +## 🔌 OpenCode 支持 + +ECC 提供 **完整的 OpenCode 支持**，包括插件和钩子。 + +### 快速开始 + +```bash +# Install OpenCode +npm install -g opencode + +# Run in the repository root +opencode +``` + +配置会自动从 `.opencode/opencode.json` 检测。 + +### 功能对等 + +| 特性 | Claude Code | OpenCode | 状态 | +|---------|-------------|----------|--------| +| 智能体 | ✅ 14 agents | ✅ 12 agents | **Claude Code 领先** | +| 命令 | ✅ 30 commands | ✅ 24 commands | **Claude Code 领先** | +| 技能 | ✅ 28 skills | ✅ 16 skills | **Claude Code 领先** | +| 钩子 | ✅ 3 phases | ✅ 20+ events | **OpenCode 更多！** | +| 规则 | ✅ 8 rules | ✅ 8 rules | **完全一致** | +| MCP Servers | ✅ Full | ✅ Full | **完全一致** | +| 自定义工具 | ✅ Via hooks | ✅ Native support | **OpenCode 更好** | + +### 通过插件实现的钩子支持 + +OpenCode 的插件系统比 Claude Code 更复杂，有 20 多种事件类型： + +| Claude Code 钩子 | OpenCode 插件事件 | +|-----------------|----------------------| +| PreToolUse | `tool.execute.before` | +| PostToolUse | `tool.execute.after` | +| Stop | `session.idle` | +| SessionStart | `session.created` | +| SessionEnd | `session.deleted` | + +**额外的 OpenCode 事件**：`file.edited`、`file.watcher.updated`、`message.updated`、`lsp.client.diagnostics`、`tui.toast.show` 等等。 + +### 可用命令 (24) + +| 命令 | 描述 | +|---------|-------------| +| `/plan` | 创建实施计划 | +| `/tdd` | 强制执行 TDD 工作流 | +| `/code-review` | 审查代码变更 | +| `/security` | 运行安全审查 | +| `/build-fix` | 修复构建错误 | +| `/e2e` | 生成端到端测试 | +| `/refactor-clean` | 移除死代码 | +| `/orchestrate` | 多代理工作流 | +| `/learn` | 从会话中提取模式 | +| `/checkpoint` | 保存验证状态 | +| `/verify` | 运行验证循环 | +| `/eval` | 根据标准进行评估 | +| `/update-docs` | 更新文档 | +| `/update-codemaps` | 更新代码地图 | +| `/test-coverage` | 分析覆盖率 | +| `/go-review` | Go 代码审查 | +| `/go-test` | Go TDD 工作流 | +| `/go-build` | 修复 Go 构建错误 | +| `/skill-create` | 从 git 生成技能 | +| `/instinct-status` | 查看习得的本能 | +| `/instinct-import` | 导入本能 | +| `/instinct-export` | 导出本能 | +| `/evolve` | 将本能聚类为技能 | +| `/setup-pm` | 配置包管理器 | + +### 插件安装 + +**选项 1：直接使用** + +```bash +cd everything-claude-code +opencode +``` + +**选项 2：作为 npm 包安装** + +```bash +npm install ecc-universal +``` + +然后添加到您的 `opencode.json`： + +```json +{ + "plugin": ["ecc-universal"] +} +``` + +### 文档 + +* **迁移指南**：`.opencode/MIGRATION.md` +* **OpenCode 插件 README**：`.opencode/README.md` +* **整合的规则**：`.opencode/instructions/INSTRUCTIONS.md` +* **LLM 文档**：`llms.txt`（完整的 OpenCode 文档，供 LLM 使用） *** @@ -542,10 +780,11 @@ node tests/hooks/hooks.test.js ## 🔗 链接 -* **简明指南（从此开始）：** [Everything Claude Code 简明指南](https://x.com/affaanmustafa/status/2012378465664745795) -* **详细指南（高级）：** [Everything Claude Code 详细指南](https://x.com/affaanmustafa/status/2014040193557471352) -* **关注：** [@affaanmustafa](https://x.com/affaanmustafa) -* **zenith.chat：** [zenith.chat](https://zenith.chat) +* **速查指南 (从此开始):** [Claude Code 万事速查指南](https://x.com/affaanmustafa/status/2012378465664745795) +* **详细指南 (进阶):** [Claude Code 万事详细指南](https://x.com/affaanmustafa/status/2014040193557471352) +* **关注:** [@affaanmustafa](https://x.com/affaanmustafa) +* **zenith.chat:** [zenith.chat](https://zenith.chat) +* **技能目录:** [awesome-agent-skills](https://github.com/JackyST0/awesome-agent-skills) *** diff --git a/docs/zh-CN/SPONSORS.md b/docs/zh-CN/SPONSORS.md new file mode 100644 index 0000000..09aebe5 --- /dev/null +++ b/docs/zh-CN/SPONSORS.md @@ -0,0 +1,47 @@ +# 赞助者 + +感谢所有赞助本项目的各位！你们的支持让 ECC 生态系统持续成长。 + +## 企业赞助者 + +*成为 [企业赞助者](https://github.com/sponsors/affaan-m)，将您的名字展示在此处* + +## 商业赞助者 + +*成为 [商业赞助者](https://github.com/sponsors/affaan-m)，将您的名字展示在此处* + +## 团队赞助者 + +*成为 [团队赞助者](https://github.com/sponsors/affaan-m)，将您的名字展示在此处* + +## 个人赞助者 + +*成为 [赞助者](https://github.com/sponsors/affaan-m)，将您的名字列在此处* + +*** + +## 为什么要赞助？ + +您的赞助将帮助我们： + +* **更快地交付** — 更多时间投入到工具和功能的开发上 +* **保持免费** — 高级功能为所有人的免费层级提供资金支持 +* **更好的支持** — 赞助者获得优先响应 +* **影响路线图** — Pro+ 赞助者可以对功能进行投票 + +## 赞助等级 + +| 等级 | 价格 | 权益 | +|------|-------|----------| +| 支持者 | $5/月 | 名字出现在 README 中，早期访问 | +| 建造者 | $10/月 | 高级工具访问权限 | +| 专业版 | $25/月 | 优先支持，办公时间咨询 | +| 团队 | $100/月 | 5个席位，团队配置 | +| 商业 | $500/月 | 25个席位，咨询额度 | +| 企业 | $2K/月 | 无限席位，定制工具 | + +[**Become a Sponsor →**](https://github.com/sponsors/affaan-m) + +*** + +*自动更新。最后同步：2026年2月* diff --git a/docs/zh-CN/commands/go-test.md b/docs/zh-CN/commands/go-test.md new file mode 100644 index 0000000..0f46620 --- /dev/null +++ b/docs/zh-CN/commands/go-test.md @@ -0,0 +1,274 @@ +--- +description: 为Go强制执行TDD工作流程。首先编写表驱动测试，然后实现。使用go test -cover验证80%以上的覆盖率。 +--- + +# Go TDD 命令 + +此命令使用惯用的 Go 测试模式，为 Go 代码强制执行测试驱动开发方法。 + +## 此命令的作用 + +1. **定义类型/接口**：首先搭建函数签名 +2. **编写表驱动测试**：创建全面的测试用例（RED 阶段） +3. **运行测试**：验证测试因正确原因而失败 +4. **实现代码**：编写最少的代码以通过测试（GREEN 阶段） +5. **重构**：改进代码，同时保持测试通过 +6. **检查覆盖率**：确保 80% 以上的覆盖率 + +## 何时使用 + +在以下情况下使用 `/go-test`： + +* 实现新的 Go 函数时 +* 为现有代码添加测试覆盖率时 +* 修复 bug 时（先编写失败的测试） +* 构建关键业务逻辑时 +* 学习 Go 中的 TDD 工作流程时 + +## TDD 循环 + +``` +RED → Write failing table-driven test +GREEN → Implement minimal code to pass +REFACTOR → Improve code, tests stay green +REPEAT → Next test case +``` + +## 示例会话 + +```` +User: /go-test I need a function to validate email addresses + +Agent: +# TDD Session: Email Validator + +## Step 1: Define Interface + +```go +// validator/email.go +package validator + +// ValidateEmail checks if the given string is a valid email address. +// Returns nil if valid, error describing the issue otherwise. +func ValidateEmail(email string) error { + panic("not implemented") +} +``` + +## Step 2: Write Table-Driven Tests (RED) + +```go +// validator/email_test.go +package validator + +import ( + "testing" +) + +func TestValidateEmail(t *testing.T) { + tests := []struct { + name string + email string + wantErr bool + }{ + // Valid emails + {"simple email", "user@example.com", false}, + {"with subdomain", "user@mail.example.com", false}, + {"with plus", "user+tag@example.com", false}, + {"with dots", "first.last@example.com", false}, + + // Invalid emails + {"empty string", "", true}, + {"no at sign", "userexample.com", true}, + {"no domain", "user@", true}, + {"no local part", "@example.com", true}, + {"double at", "user@@example.com", true}, + {"spaces", "user @example.com", true}, + {"no tld", "user@example", true}, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + err := ValidateEmail(tt.email) + if tt.wantErr && err == nil { + t.Errorf("ValidateEmail(%q) = nil; want error", tt.email) + } + if !tt.wantErr && err != nil { + t.Errorf("ValidateEmail(%q) = %v; want nil", tt.email, err) + } + }) + } +} +``` + +## Step 3: Run Tests - Verify FAIL + +```bash +$ go test ./validator/... + +--- FAIL: TestValidateEmail (0.00s) + --- FAIL: TestValidateEmail/simple_email (0.00s) + panic: not implemented + +FAIL +``` + +✓ Tests fail as expected (panic). + +## Step 4: Implement Minimal Code (GREEN) + +```go +// validator/email.go +package validator + +import ( + "errors" + "regexp" +) + +var emailRegex = regexp.MustCompile(`^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$`) + +var ( + ErrEmailEmpty = errors.New("email cannot be empty") + ErrEmailInvalid = errors.New("email format is invalid") +) + +func ValidateEmail(email string) error { + if email == "" { + return ErrEmailEmpty + } + if !emailRegex.MatchString(email) { + return ErrEmailInvalid + } + return nil +} +``` + +## Step 5: Run Tests - Verify PASS + +```bash +$ go test ./validator/... + +PASS +ok project/validator 0.003s +``` + +✓ All tests passing! + +## Step 6: Check Coverage + +```bash +$ go test -cover ./validator/... + +PASS +coverage: 100.0% of statements +ok project/validator 0.003s +``` + +✓ Coverage: 100% + +## TDD Complete! +```` + +## 测试模式 + +### 表驱动测试 + +```go +tests := []struct { + name string + input InputType + want OutputType + wantErr bool +}{ + {"case 1", input1, want1, false}, + {"case 2", input2, want2, true}, +} + +for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got, err := Function(tt.input) + // assertions + }) +} +``` + +### 并行测试 + +```go +for _, tt := range tests { + tt := tt // Capture + t.Run(tt.name, func(t *testing.T) { + t.Parallel() + // test body + }) +} +``` + +### 测试辅助函数 + +```go +func setupTestDB(t *testing.T) *sql.DB { + t.Helper() + db := createDB() + t.Cleanup(func() { db.Close() }) + return db +} +``` + +## 覆盖率命令 + +```bash +# Basic coverage +go test -cover ./... + +# Coverage profile +go test -coverprofile=coverage.out ./... + +# View in browser +go tool cover -html=coverage.out + +# Coverage by function +go tool cover -func=coverage.out + +# With race detection +go test -race -cover ./... +``` + +## 覆盖率目标 + +| 代码类型 | 目标 | +|-----------|--------| +| 关键业务逻辑 | 100% | +| 公共 API | 90%+ | +| 通用代码 | 80%+ | +| 生成的代码 | 排除 | + +## TDD 最佳实践 + +**应该做：** + +* 先编写测试，再编写任何实现 +* 每次更改后运行测试 +* 使用表驱动测试以获得全面的覆盖率 +* 测试行为，而非实现细节 +* 包含边界情况（空值、nil、最大值） + +**不应该做：** + +* 在编写测试之前编写实现 +* 跳过 RED 阶段 +* 直接测试私有函数 +* 在测试中使用 `time.Sleep` +* 忽略不稳定的测试 + +## 相关命令 + +* `/go-build` - 修复构建错误 +* `/go-review` - 在实现后审查代码 +* `/verify` - 运行完整的验证循环 + +## 相关 + +* 技能：`skills/golang-testing/` +* 技能：`skills/tdd-workflow/` diff --git a/docs/zh-CN/commands/multi-backend.md b/docs/zh-CN/commands/multi-backend.md new file mode 100644 index 0000000..db6c43a --- /dev/null +++ b/docs/zh-CN/commands/multi-backend.md @@ -0,0 +1,162 @@ +# 后端 - 后端导向开发 + +后端导向的工作流程（研究 → 构思 → 规划 → 执行 → 优化 → 评审），由 Codex 主导。 + +## 使用方法 + +```bash +/backend +``` + +## 上下文 + +* 后端任务：$ARGUMENTS +* Codex 主导，Gemini 作为辅助参考 +* 适用场景：API 设计、算法实现、数据库优化、业务逻辑 + +## 你的角色 + +你是 **后端协调者**，为服务器端任务协调多模型协作（研究 → 构思 → 规划 → 执行 → 优化 → 评审）。 + +**协作模型**： + +* **Codex** – 后端逻辑、算法（**后端权威，可信赖**） +* **Gemini** – 前端视角（**后端意见仅供参考**） +* **Claude (自身)** – 协调、规划、执行、交付 + +*** + +## 多模型调用规范 + +**调用语法**： + +``` +# New session call +Bash({ + command: "~/.claude/bin/codeagent-wrapper {{LITE_MODE_FLAG}}--backend codex - \"$PWD\" <<'EOF' +ROLE_FILE: + +Requirement: +Context: + +OUTPUT: Expected output format +EOF", + run_in_background: false, + timeout: 3600000, + description: "Brief description" +}) + +# Resume session call +Bash({ + command: "~/.claude/bin/codeagent-wrapper {{LITE_MODE_FLAG}}--backend codex resume - \"$PWD\" <<'EOF' +ROLE_FILE: + +Requirement: +Context: + +OUTPUT: Expected output format +EOF", + run_in_background: false, + timeout: 3600000, + description: "Brief description" +}) +``` + +**角色提示词**： + +| 阶段 | Codex | +|-------|-------| +| 分析 | `~/.claude/.ccg/prompts/codex/analyzer.md` | +| 规划 | `~/.claude/.ccg/prompts/codex/architect.md` | +| 评审 | `~/.claude/.ccg/prompts/codex/reviewer.md` | + +**会话复用**：每次调用返回 `SESSION_ID: xxx`，在后续阶段使用 `resume xxx`。在第 2 阶段保存 `CODEX_SESSION`，在第 3 和第 5 阶段使用 `resume`。 + +*** + +## 沟通准则 + +1. 在回复开头使用模式标签 `[Mode: X]`，初始值为 `[Mode: Research]` +2. 遵循严格序列：`Research → Ideation → Plan → Execute → Optimize → Review` +3. 需要时（例如确认/选择/批准）使用 `AskUserQuestion` 工具进行用户交互 + +*** + +## 核心工作流程 + +### 阶段 0：提示词增强（可选） + +`[Mode: Prepare]` - 如果 ace-tool MCP 可用，调用 `mcp__ace-tool__enhance_prompt`，**用增强后的结果替换原始的 $ARGUMENTS，用于后续的 Codex 调用** + +### 阶段 1：研究 + +`[Mode: Research]` - 理解需求并收集上下文 + +1. **代码检索**（如果 ace-tool MCP 可用）：调用 `mcp__ace-tool__search_context` 以检索现有的 API、数据模型、服务架构 +2. 需求完整性评分（0-10）：>=7 继续，<7 停止并补充 + +### 阶段 2：构思 + +`[Mode: Ideation]` - Codex 主导的分析 + +**必须调用 Codex**（遵循上述调用规范）： + +* ROLE\_FILE：`~/.claude/.ccg/prompts/codex/analyzer.md` +* 需求：增强后的需求（或未增强时的 $ARGUMENTS） +* 上下文：来自阶段 1 的项目上下文 +* 输出：技术可行性分析、推荐解决方案（至少 2 个）、风险评估 + +**保存 SESSION\_ID**（`CODEX_SESSION`）以供后续阶段复用。 + +输出解决方案（至少 2 个），等待用户选择。 + +### 阶段 3：规划 + +`[Mode: Plan]` - Codex 主导的规划 + +**必须调用 Codex**（使用 `resume ` 以复用会话）： + +* ROLE\_FILE：`~/.claude/.ccg/prompts/codex/architect.md` +* 需求：用户选择的解决方案 +* 上下文：阶段 2 的分析结果 +* 输出：文件结构、函数/类设计、依赖关系 + +Claude 综合规划，在用户批准后保存到 `.claude/plan/task-name.md`。 + +### 阶段 4：实施 + +`[Mode: Execute]` - 代码开发 + +* 严格遵循已批准的规划 +* 遵循现有项目的代码规范 +* 确保错误处理、安全性、性能优化 + +### 阶段 5：优化 + +`[Mode: Optimize]` - Codex 主导的评审 + +**必须调用 Codex**（遵循上述调用规范）： + +* ROLE\_FILE：`~/.claude/.ccg/prompts/codex/reviewer.md` +* 需求：评审以下后端代码变更 +* 上下文：git diff 或代码内容 +* 输出：安全性、性能、错误处理、API 合规性问题列表 + +整合评审反馈，在用户确认后执行优化。 + +### 阶段 6：质量评审 + +`[Mode: Review]` - 最终评估 + +* 对照规划检查完成情况 +* 运行测试以验证功能 +* 报告问题和建议 + +*** + +## 关键规则 + +1. **Codex 的后端意见是可信赖的** +2. **Gemini 的后端意见仅供参考** +3. 外部模型**对文件系统零写入权限** +4. Claude 处理所有代码写入和文件操作 diff --git a/docs/zh-CN/commands/multi-execute.md b/docs/zh-CN/commands/multi-execute.md new file mode 100644 index 0000000..0935991 --- /dev/null +++ b/docs/zh-CN/commands/multi-execute.md @@ -0,0 +1,315 @@ +# 执行 - 多模型协同执行 + +多模型协同执行 - 从计划获取原型 → Claude 重构并实施 → 多模型审计与交付。 + +$ARGUMENTS + +*** + +## 核心协议 + +* **语言协议**：与工具/模型交互时使用**英语**，与用户沟通时使用用户的语言 +* **代码主权**：外部模型**零文件系统写入权限**，所有修改由 Claude 执行 +* **脏原型重构**：将 Codex/Gemini 统一差异视为“脏原型”，必须重构为生产级代码 +* **止损机制**：当前阶段输出未经验证前，不得进入下一阶段 +* **前提条件**：仅在用户明确回复“Y”到 `/ccg:plan` 输出后执行（如果缺失，必须先确认） + +*** + +## 多模型调用规范 + +**调用语法**（并行：使用 `run_in_background: true`）： + +``` +# Resume session call (recommended) - Implementation Prototype +Bash({ + command: "~/.claude/bin/codeagent-wrapper {{LITE_MODE_FLAG}}--backend {{GEMINI_MODEL_FLAG}}resume - \"$PWD\" <<'EOF' +ROLE_FILE: + +Requirement: +Context: + +OUTPUT: Unified Diff Patch ONLY. Strictly prohibit any actual modifications. +EOF", + run_in_background: true, + timeout: 3600000, + description: "Brief description" +}) + +# New session call - Implementation Prototype +Bash({ + command: "~/.claude/bin/codeagent-wrapper {{LITE_MODE_FLAG}}--backend {{GEMINI_MODEL_FLAG}}- \"$PWD\" <<'EOF' +ROLE_FILE: + +Requirement: +Context: + +OUTPUT: Unified Diff Patch ONLY. Strictly prohibit any actual modifications. +EOF", + run_in_background: true, + timeout: 3600000, + description: "Brief description" +}) +``` + +**审计调用语法**（代码审查 / 审计）： + +``` +Bash({ + command: "~/.claude/bin/codeagent-wrapper {{LITE_MODE_FLAG}}--backend {{GEMINI_MODEL_FLAG}}resume - \"$PWD\" <<'EOF' +ROLE_FILE: + +Scope: Audit the final code changes. +Inputs: +- The applied patch (git diff / final unified diff) +- The touched files (relevant excerpts if needed) +Constraints: +- Do NOT modify any files. +- Do NOT output tool commands that assume filesystem access. + +OUTPUT: +1) A prioritized list of issues (severity, file, rationale) +2) Concrete fixes; if code changes are needed, include a Unified Diff Patch in a fenced code block. +EOF", + run_in_background: true, + timeout: 3600000, + description: "Brief description" +}) +``` + +**模型参数说明**： + +* `{{GEMINI_MODEL_FLAG}}`：当使用 `--backend gemini` 时，替换为 `--gemini-model gemini-3-pro-preview`（注意尾随空格）；对于 codex 使用空字符串 + +**角色提示**： + +| 阶段 | Codex | Gemini | +|-------|-------|--------| +| 实施 | `~/.claude/.ccg/prompts/codex/architect.md` | `~/.claude/.ccg/prompts/gemini/frontend.md` | +| 审查 | `~/.claude/.ccg/prompts/codex/reviewer.md` | `~/.claude/.ccg/prompts/gemini/reviewer.md` | + +**会话重用**：如果 `/ccg:plan` 提供了 SESSION\_ID，使用 `resume ` 来重用上下文。 + +**等待后台任务**（最大超时 600000ms = 10 分钟）： + +``` +TaskOutput({ task_id: "", block: true, timeout: 600000 }) +``` + +**重要**： + +* 必须指定 `timeout: 600000`，否则默认 30 秒会导致过早超时 +* 如果 10 分钟后仍未完成，继续使用 `TaskOutput` 轮询，**切勿终止进程** +* 如果因超时而跳过等待，**必须调用 `AskUserQuestion` 询问用户是继续等待还是终止任务** + +*** + +## 执行工作流 + +**执行任务**：$ARGUMENTS + +### 阶段 0：读取计划 + +`[Mode: Prepare]` + +1. **识别输入类型**： + * 计划文件路径（例如 `.claude/plan/xxx.md`） + * 直接任务描述 + +2. **读取计划内容**： + * 如果提供了计划文件路径，读取并解析 + * 提取：任务类型、实施步骤、关键文件、SESSION\_ID + +3. **执行前确认**： + * 如果输入是“直接任务描述”或计划缺少 `SESSION_ID` / 关键文件：先与用户确认 + * 如果无法确认用户已回复“Y”到计划：在继续前必须再次确认 + +4. **任务类型路由**： + + | 任务类型 | 检测 | 路由 | + |-----------|-----------|-------| + | **前端** | 页面、组件、UI、样式、布局 | Gemini | + | **后端** | API、接口、数据库、逻辑、算法 | Codex | + | **全栈** | 包含前端和后端 | Codex ∥ Gemini 并行 | + +*** + +### 阶段 1：快速上下文检索 + +`[Mode: Retrieval]` + +**必须使用 MCP 工具进行快速上下文检索，切勿手动逐个读取文件** + +基于计划中的“关键文件”列表，调用 `mcp__ace-tool__search_context`： + +``` +mcp__ace-tool__search_context({ + query: "", + project_root_path: "$PWD" +}) +``` + +**检索策略**： + +* 从计划的“关键文件”表中提取目标路径 +* 构建语义查询覆盖：入口文件、依赖模块、相关类型定义 +* 如果结果不足，添加 1-2 次递归检索 +* **切勿**使用 Bash + find/ls 手动探索项目结构 + +**检索后**： + +* 组织检索到的代码片段 +* 确认实施所需的完整上下文 +* 进入阶段 3 + +*** + +### 阶段 3：原型获取 + +`[Mode: Prototype]` + +**基于任务类型路由**： + +#### 路由 A：前端/UI/样式 → Gemini + +**限制**：上下文 < 32k 令牌 + +1. 调用 Gemini（使用 `~/.claude/.ccg/prompts/gemini/frontend.md`） +2. 输入：计划内容 + 检索到的上下文 + 目标文件 +3. 输出：`Unified Diff Patch ONLY. Strictly prohibit any actual modifications.` +4. **Gemini 是前端设计权威，其 CSS/React/Vue 原型是最终的视觉基线** +5. **警告**：忽略 Gemini 的后端逻辑建议 +6. 如果计划包含 `GEMINI_SESSION`：优先使用 `resume ` + +#### 路由 B：后端/逻辑/算法 → Codex + +1. 调用 Codex（使用 `~/.claude/.ccg/prompts/codex/architect.md`） +2. 输入：计划内容 + 检索到的上下文 + 目标文件 +3. 输出：`Unified Diff Patch ONLY. Strictly prohibit any actual modifications.` +4. **Codex 是后端逻辑权威，利用其逻辑推理和调试能力** +5. 如果计划包含 `CODEX_SESSION`：优先使用 `resume ` + +#### 路由 C：全栈 → 并行调用 + +1. **并行调用**（`run_in_background: true`）： + * Gemini：处理前端部分 + * Codex：处理后端部分 +2. 使用 `TaskOutput` 等待两个模型的完整结果 +3. 每个模型使用计划中相应的 `SESSION_ID` 作为 `resume`（如果缺失则创建新会话） + +**遵循上面 `IMPORTANT` 中的 `Multi-Model Call Specification` 指令** + +*** + +### 阶段 4：代码实施 + +`[Mode: Implement]` + +**Claude 作为代码主权执行以下步骤**： + +1. **读取差异**：解析 Codex/Gemini 返回的统一差异补丁 + +2. **心智沙盒**： + * 模拟将差异应用到目标文件 + * 检查逻辑一致性 + * 识别潜在冲突或副作用 + +3. **重构与清理**： + * 将“脏原型”重构为**高度可读、可维护、企业级代码** + * 移除冗余代码 + * 确保符合项目现有代码标准 + * **除非必要，不要生成注释/文档**，代码应具有自解释性 + +4. **最小范围**： + * 更改仅限于需求范围 + * **强制审查**副作用 + * 进行针对性修正 + +5. **应用更改**： + * 使用编辑/写入工具执行实际修改 + * **仅修改必要代码**，绝不影响用户的其他现有功能 + +6. **自验证**（强烈推荐）： + * 运行项目现有的 lint / 类型检查 / 测试（优先考虑最小相关范围） + * 如果失败：先修复回归问题，然后进入阶段 5 + +*** + +### 阶段 5：审计与交付 + +`[Mode: Audit]` + +#### 5.1 自动审计 + +**更改生效后，必须立即并行调用** Codex 和 Gemini 进行代码审查： + +1. **Codex 审查**（`run_in_background: true`）： + * ROLE\_FILE：`~/.claude/.ccg/prompts/codex/reviewer.md` + * 输入：更改的差异 + 目标文件 + * 重点：安全性、性能、错误处理、逻辑正确性 + +2. **Gemini 审查**（`run_in_background: true`）： + * ROLE\_FILE：`~/.claude/.ccg/prompts/gemini/reviewer.md` + * 输入：更改的差异 + 目标文件 + * 重点：可访问性、设计一致性、用户体验 + +使用 `TaskOutput` 等待两个模型的完整审查结果。优先重用阶段 3 的会话（`resume `）以确保上下文一致性。 + +#### 5.2 整合与修复 + +1. 综合 Codex + Gemini 的审查反馈 +2. 按信任规则权衡：后端遵循 Codex，前端遵循 Gemini +3. 执行必要的修复 +4. 根据需要重复阶段 5.1（直到风险可接受） + +#### 5.3 交付确认 + +审计通过后，向用户报告： + +```markdown +## 执行完成 + +### 变更摘要 +| 文件 | 操作 | 描述 | +|------|-----------|-------------| +| path/to/file.ts | 已修改 | 描述 | + +### 审计结果 +- Codex: <通过/发现 N 个问题> +- Gemini: <通过/发现 N 个问题> + +### 建议 +1. [ ] <建议的测试步骤> +2. [ ] <建议的验证步骤> + +``` + +*** + +## 关键规则 + +1. **代码主权** – 所有文件修改由 Claude 执行，外部模型零写入权限 +2. **脏原型重构** – Codex/Gemini 输出视为草稿，必须重构 +3. **信任规则** – 后端遵循 Codex，前端遵循 Gemini +4. **最小更改** – 仅修改必要代码，无副作用 +5. **强制审计** – 更改后必须执行多模型代码审查 + +*** + +## 使用方法 + +```bash +# Execute plan file +/ccg:execute .claude/plan/feature-name.md + +# Execute task directly (for plans already discussed in context) +/ccg:execute implement user authentication based on previous plan +``` + +*** + +## 与 /ccg:plan 的关系 + +1. `/ccg:plan` 生成计划 + SESSION\_ID +2. 用户用“Y”确认 +3. `/ccg:execute` 读取计划，重用 SESSION\_ID，执行实施 diff --git a/docs/zh-CN/commands/multi-frontend.md b/docs/zh-CN/commands/multi-frontend.md new file mode 100644 index 0000000..59a03ed --- /dev/null +++ b/docs/zh-CN/commands/multi-frontend.md @@ -0,0 +1,162 @@ +# 前端 - 前端聚焦开发 + +前端聚焦的工作流（研究 → 构思 → 规划 → 执行 → 优化 → 评审），由 Gemini 主导。 + +## 使用方法 + +```bash +/frontend +``` + +## 上下文 + +* 前端任务: $ARGUMENTS +* Gemini 主导，Codex 作为辅助参考 +* 适用场景: 组件设计、响应式布局、UI 动画、样式优化 + +## 您的角色 + +您是 **前端协调器**，为 UI/UX 任务协调多模型协作（研究 → 构思 → 规划 → 执行 → 优化 → 评审）。 + +**协作模型**: + +* **Gemini** – 前端 UI/UX（**前端权威，可信赖**） +* **Codex** – 后端视角（**前端意见仅供参考**） +* **Claude（自身）** – 协调、规划、执行、交付 + +*** + +## 多模型调用规范 + +**调用语法**: + +``` +# New session call +Bash({ + command: "~/.claude/bin/codeagent-wrapper {{LITE_MODE_FLAG}}--backend gemini --gemini-model gemini-3-pro-preview - \"$PWD\" <<'EOF' +ROLE_FILE: + +Requirement: +Context: + +OUTPUT: Expected output format +EOF", + run_in_background: false, + timeout: 3600000, + description: "Brief description" +}) + +# Resume session call +Bash({ + command: "~/.claude/bin/codeagent-wrapper {{LITE_MODE_FLAG}}--backend gemini --gemini-model gemini-3-pro-preview resume - \"$PWD\" <<'EOF' +ROLE_FILE: + +Requirement: +Context: + +OUTPUT: Expected output format +EOF", + run_in_background: false, + timeout: 3600000, + description: "Brief description" +}) +``` + +**角色提示词**: + +| 阶段 | Gemini | +|-------|--------| +| 分析 | `~/.claude/.ccg/prompts/gemini/analyzer.md` | +| 规划 | `~/.claude/.ccg/prompts/gemini/architect.md` | +| 评审 | `~/.claude/.ccg/prompts/gemini/reviewer.md` | + +**会话重用**: 每次调用返回 `SESSION_ID: xxx`，在后续阶段使用 `resume xxx`。在阶段 2 保存 `GEMINI_SESSION`，在阶段 3 和 5 使用 `resume`。 + +*** + +## 沟通指南 + +1. 以模式标签 `[Mode: X]` 开始响应，初始为 `[Mode: Research]` +2. 遵循严格顺序: `Research → Ideation → Plan → Execute → Optimize → Review` +3. 需要时（例如确认/选择/批准）使用 `AskUserQuestion` 工具进行用户交互 + +*** + +## 核心工作流 + +### 阶段 0: 提示词增强（可选） + +`[Mode: Prepare]` - 如果 ace-tool MCP 可用，调用 `mcp__ace-tool__enhance_prompt`，**将原始的 $ARGUMENTS 替换为增强后的结果，用于后续的 Gemini 调用** + +### 阶段 1: 研究 + +`[Mode: Research]` - 理解需求并收集上下文 + +1. **代码检索**（如果 ace-tool MCP 可用）: 调用 `mcp__ace-tool__search_context` 来检索现有的组件、样式、设计系统 +2. 需求完整性评分（0-10）: >=7 继续，<7 停止并补充 + +### 阶段 2: 构思 + +`[Mode: Ideation]` - Gemini 主导的分析 + +**必须调用 Gemini**（遵循上述调用规范）: + +* ROLE\_FILE: `~/.claude/.ccg/prompts/gemini/analyzer.md` +* 需求: 增强后的需求（或未经增强的 $ARGUMENTS） +* 上下文: 来自阶段 1 的项目上下文 +* 输出: UI 可行性分析、推荐解决方案（至少 2 个）、UX 评估 + +**保存 SESSION\_ID**（`GEMINI_SESSION`）以供后续阶段重用。 + +输出解决方案（至少 2 个），等待用户选择。 + +### 阶段 3: 规划 + +`[Mode: Plan]` - Gemini 主导的规划 + +**必须调用 Gemini**（使用 `resume ` 来重用会话）: + +* ROLE\_FILE: `~/.claude/.ccg/prompts/gemini/architect.md` +* 需求: 用户选择的解决方案 +* 上下文: 阶段 2 的分析结果 +* 输出: 组件结构、UI 流程、样式方案 + +Claude 综合规划，在用户批准后保存到 `.claude/plan/task-name.md`。 + +### 阶段 4: 实现 + +`[Mode: Execute]` - 代码开发 + +* 严格遵循批准的规划 +* 遵循现有项目设计系统和代码标准 +* 确保响应式设计、可访问性 + +### 阶段 5: 优化 + +`[Mode: Optimize]` - Gemini 主导的评审 + +**必须调用 Gemini**（遵循上述调用规范）: + +* ROLE\_FILE: `~/.claude/.ccg/prompts/gemini/reviewer.md` +* 需求: 评审以下前端代码变更 +* 上下文: git diff 或代码内容 +* 输出: 可访问性、响应式设计、性能、设计一致性等问题列表 + +整合评审反馈，在用户确认后执行优化。 + +### 阶段 6: 质量评审 + +`[Mode: Review]` - 最终评估 + +* 对照规划检查完成情况 +* 验证响应式设计和可访问性 +* 报告问题与建议 + +*** + +## 关键规则 + +1. **Gemini 的前端意见是可信赖的** +2. **Codex 的前端意见仅供参考** +3. 外部模型**没有文件系统写入权限** +4. Claude 处理所有代码写入和文件操作 diff --git a/docs/zh-CN/commands/multi-plan.md b/docs/zh-CN/commands/multi-plan.md new file mode 100644 index 0000000..1f3136f --- /dev/null +++ b/docs/zh-CN/commands/multi-plan.md @@ -0,0 +1,270 @@ +# 计划 - 多模型协同规划 + +多模型协同规划 - 上下文检索 + 双模型分析 → 生成分步实施计划。 + +$ARGUMENTS + +*** + +## 核心协议 + +* **语言协议**：与工具/模型交互时使用 **英语**，与用户沟通时使用其语言 +* **强制并行**：Codex/Gemini 调用 **必须** 使用 `run_in_background: true`（包括单模型调用，以避免阻塞主线程） +* **代码主权**：外部模型 **零文件系统写入权限**，所有修改由 Claude 执行 +* **止损机制**：在当前阶段输出验证完成前，不进入下一阶段 +* **仅限规划**：此命令允许读取上下文并写入 `.claude/plan/*` 计划文件，但 **绝不修改生产代码** + +*** + +## 多模型调用规范 + +**调用语法**（并行：使用 `run_in_background: true`）： + +``` +Bash({ + command: "~/.claude/bin/codeagent-wrapper {{LITE_MODE_FLAG}}--backend {{GEMINI_MODEL_FLAG}}- \"$PWD\" <<'EOF' +ROLE_FILE: + +Requirement: +Context: + +OUTPUT: Step-by-step implementation plan with pseudo-code. DO NOT modify any files. +EOF", + run_in_background: true, + timeout: 3600000, + description: "Brief description" +}) +``` + +**模型参数说明**： + +* `{{GEMINI_MODEL_FLAG}}`: 当使用 `--backend gemini` 时，替换为 `--gemini-model gemini-3-pro-preview`（注意尾随空格）；对于 codex 使用空字符串 + +**角色提示**： + +| 阶段 | Codex | Gemini | +|-------|-------|--------| +| 分析 | `~/.claude/.ccg/prompts/codex/analyzer.md` | `~/.claude/.ccg/prompts/gemini/analyzer.md` | +| 规划 | `~/.claude/.ccg/prompts/codex/architect.md` | `~/.claude/.ccg/prompts/gemini/architect.md` | + +**会话复用**：每次调用返回 `SESSION_ID: xxx`（通常由包装器输出），**必须保存** 供后续 `/ccg:execute` 使用。 + +**等待后台任务**（最大超时 600000ms = 10 分钟）： + +``` +TaskOutput({ task_id: "", block: true, timeout: 600000 }) +``` + +**重要提示**： + +* 必须指定 `timeout: 600000`，否则默认 30 秒会导致过早超时 +* 如果 10 分钟后仍未完成，继续使用 `TaskOutput` 轮询，**绝不终止进程** +* 如果因超时而跳过等待，**必须调用 `AskUserQuestion` 询问用户是继续等待还是终止任务** + +*** + +## 执行流程 + +**规划任务**：$ARGUMENTS + +### 阶段 1：完整上下文检索 + +`[Mode: Research]` + +#### 1.1 提示增强（必须先执行） + +**必须调用 `mcp__ace-tool__enhance_prompt` 工具**： + +``` +mcp__ace-tool__enhance_prompt({ + prompt: "$ARGUMENTS", + conversation_history: "", + project_root_path: "$PWD" +}) +``` + +等待增强后的提示，**将所有后续阶段的原始 $ARGUMENTS 替换为增强结果**。 + +#### 1.2 上下文检索 + +**调用 `mcp__ace-tool__search_context` 工具**： + +``` +mcp__ace-tool__search_context({ + query: "", + project_root_path: "$PWD" +}) +``` + +* 使用自然语言构建语义查询（Where/What/How） +* **绝不基于假设回答** +* 如果 MCP 不可用：回退到 Glob + Grep 进行文件发现和关键符号定位 + +#### 1.3 完整性检查 + +* 必须获取相关类、函数、变量的 **完整定义和签名** +* 如果上下文不足，触发 **递归检索** +* 输出优先级：入口文件 + 行号 + 关键符号名称；仅在必要时添加最小代码片段以消除歧义 + +#### 1.4 需求对齐 + +* 如果需求仍有歧义，**必须** 输出引导性问题给用户 +* 直到需求边界清晰（无遗漏，无冗余） + +### 阶段 2：多模型协同分析 + +`[Mode: Analysis]` + +#### 2.1 分发输入 + +**并行调用** Codex 和 Gemini（`run_in_background: true`）： + +将 **原始需求**（不预设观点）分发给两个模型： + +1. **Codex 后端分析**： + * ROLE\_FILE：`~/.claude/.ccg/prompts/codex/analyzer.md` + * 重点：技术可行性、架构影响、性能考虑、潜在风险 + * 输出：多视角解决方案 + 优缺点分析 + +2. **Gemini 前端分析**： + * ROLE\_FILE：`~/.claude/.ccg/prompts/gemini/analyzer.md` + * 重点：UI/UX 影响、用户体验、视觉设计 + * 输出：多视角解决方案 + 优缺点分析 + +使用 `TaskOutput` 等待两个模型的完整结果。**保存 SESSION\_ID**（`CODEX_SESSION` 和 `GEMINI_SESSION`）。 + +#### 2.2 交叉验证 + +整合视角并迭代优化： + +1. **识别共识**（强信号） +2. **识别分歧**（需要权衡） +3. **互补优势**：后端逻辑遵循 Codex，前端设计遵循 Gemini +4. **逻辑推理**：消除解决方案中的逻辑漏洞 + +#### 2.3（可选但推荐）双模型计划草案 + +为减少 Claude 综合计划中的遗漏风险，可以并行让两个模型输出“计划草案”（仍然 **不允许** 修改文件）： + +1. **Codex 计划草案**（后端权威）： + * ROLE\_FILE：`~/.claude/.ccg/prompts/codex/architect.md` + * 输出：分步计划 + 伪代码（重点：数据流/边缘情况/错误处理/测试策略） + +2. **Gemini 计划草案**（前端权威）： + * ROLE\_FILE：`~/.claude/.ccg/prompts/gemini/architect.md` + * 输出：分步计划 + 伪代码（重点：信息架构/交互/可访问性/视觉一致性） + +使用 `TaskOutput` 等待两个模型的完整结果，记录它们建议的关键差异。 + +#### 2.4 生成实施计划（Claude 最终版本） + +综合两个分析，生成 **分步实施计划**： + +```markdown +## 实施计划：<任务名称> + +### 任务类型 +- [ ] 前端 (→ Gemini) +- [ ] 后端 (→ Codex) +- [ ] 全栈 (→ 并行) + +### 技术解决方案 +<基于 Codex + Gemini 分析得出的最优解决方案> + +### 实施步骤 +1. <步骤 1> - 预期交付物 +2. <步骤 2> - 预期交付物 +... + +### 关键文件 +| 文件 | 操作 | 描述 | +|------|-----------|-------------| +| path/to/file.ts:L10-L50 | 修改 | 描述 | + +### 风险与缓解措施 +| 风险 | 缓解措施 | +|------|------------| + +### SESSION_ID (供 /ccg:execute 使用) +- CODEX_SESSION: +- GEMINI_SESSION: + +``` + +### 阶段 2 结束：计划交付（非执行） + +**`/ccg:plan` 的职责到此结束，必须执行以下操作**： + +1. 向用户呈现完整的实施计划（包括伪代码） + +2. 将计划保存到 `.claude/plan/.md`（从需求中提取功能名称，例如 `user-auth`，`payment-module`） + +3. 以 **粗体文本** 输出提示（必须使用实际保存的文件路径）： + + *** + + **计划已生成并保存至 `.claude/plan/actual-feature-name.md`** + + **请审阅以上计划。您可以：** + + * **修改计划**：告诉我需要调整的内容，我会更新计划 + * **执行计划**：复制以下命令到新会话 + + ``` + /ccg:execute .claude/plan/actual-feature-name.md + ``` + + *** + + **注意**：上面的 `actual-feature-name.md` 必须替换为实际保存的文件名！ + +4. **立即终止当前响应**（在此停止。不再进行工具调用。） + +**绝对禁止**： + +* 询问用户“是/否”然后自动执行（执行是 `/ccg:execute` 的职责） +* 任何对生产代码的写入操作 +* 自动调用 `/ccg:execute` 或任何实施操作 +* 当用户未明确请求修改时继续触发模型调用 + +*** + +## 计划保存 + +规划完成后，将计划保存至： + +* **首次规划**：`.claude/plan/.md` +* **迭代版本**：`.claude/plan/-v2.md`，`.claude/plan/-v3.md`... + +计划文件写入应在向用户呈现计划前完成。 + +*** + +## 计划修改流程 + +如果用户请求修改计划： + +1. 根据用户反馈调整计划内容 +2. 更新 `.claude/plan/.md` 文件 +3. 重新呈现修改后的计划 +4. 提示用户再次审阅或执行 + +*** + +## 后续步骤 + +用户批准后，**手动** 执行： + +```bash +/ccg:execute .claude/plan/.md +``` + +*** + +## 关键规则 + +1. **仅规划，不实施** – 此命令不执行任何代码更改 +2. **无是/否提示** – 仅呈现计划，让用户决定后续步骤 +3. **信任规则** – 后端遵循 Codex，前端遵循 Gemini +4. 外部模型 **零文件系统写入权限** +5. **SESSION\_ID 交接** – 计划末尾必须包含 `CODEX_SESSION` / `GEMINI_SESSION`（供 `/ccg:execute resume ` 使用） diff --git a/docs/zh-CN/commands/multi-workflow.md b/docs/zh-CN/commands/multi-workflow.md new file mode 100644 index 0000000..58e08ce --- /dev/null +++ b/docs/zh-CN/commands/multi-workflow.md @@ -0,0 +1,189 @@ +# 工作流程 - 多模型协同开发 + +多模型协同开发工作流程（研究 → 构思 → 规划 → 执行 → 优化 → 审查），带有智能路由：前端 → Gemini，后端 → Codex。 + +结构化开发工作流程，包含质量门控、MCP 服务和多模型协作。 + +## 使用方法 + +```bash +/workflow +``` + +## 上下文 + +* 待开发任务：$ARGUMENTS +* 结构化的 6 阶段工作流程，包含质量门控 +* 多模型协作：Codex（后端） + Gemini（前端） + Claude（编排） +* MCP 服务集成（ace-tool）以增强能力 + +## 你的角色 + +你是**编排者**，协调一个多模型协作系统（研究 → 构思 → 规划 → 执行 → 优化 → 审查）。为有经验的开发者进行简洁、专业的沟通。 + +**协作模型**： + +* **ace-tool MCP** – 代码检索 + 提示词增强 +* **Codex** – 后端逻辑、算法、调试（**后端权威，可信赖**） +* **Gemini** – 前端 UI/UX、视觉设计（**前端专家，后端意见仅供参考**） +* **Claude（自身）** – 编排、规划、执行、交付 + +*** + +## 多模型调用规范 + +**调用语法**（并行：`run_in_background: true`，串行：`false`）： + +``` +# New session call +Bash({ + command: "~/.claude/bin/codeagent-wrapper {{LITE_MODE_FLAG}}--backend {{GEMINI_MODEL_FLAG}}- \"$PWD\" <<'EOF' +ROLE_FILE: + +Requirement: +Context: + +OUTPUT: Expected output format +EOF", + run_in_background: true, + timeout: 3600000, + description: "Brief description" +}) + +# Resume session call +Bash({ + command: "~/.claude/bin/codeagent-wrapper {{LITE_MODE_FLAG}}--backend {{GEMINI_MODEL_FLAG}}resume - \"$PWD\" <<'EOF' +ROLE_FILE: + +Requirement: +Context: + +OUTPUT: Expected output format +EOF", + run_in_background: true, + timeout: 3600000, + description: "Brief description" +}) +``` + +**模型参数说明**： + +* `{{GEMINI_MODEL_FLAG}}`: 当使用 `--backend gemini` 时，替换为 `--gemini-model gemini-3-pro-preview`（注意末尾空格）；对于 codex 使用空字符串 + +**角色提示词**： + +| 阶段 | Codex | Gemini | +|-------|-------|--------| +| 分析 | `~/.claude/.ccg/prompts/codex/analyzer.md` | `~/.claude/.ccg/prompts/gemini/analyzer.md` | +| 规划 | `~/.claude/.ccg/prompts/codex/architect.md` | `~/.claude/.ccg/prompts/gemini/architect.md` | +| 审查 | `~/.claude/.ccg/prompts/codex/reviewer.md` | `~/.claude/.ccg/prompts/gemini/reviewer.md` | + +**会话复用**：每次调用返回 `SESSION_ID: xxx`，在后续阶段使用 `resume xxx` 子命令（注意：`resume`，而非 `--resume`）。 + +**并行调用**：使用 `run_in_background: true` 启动，使用 `TaskOutput` 等待结果。**必须等待所有模型返回后才能进入下一阶段**。 + +**等待后台任务**（使用最大超时 600000ms = 10 分钟）： + +``` +TaskOutput({ task_id: "", block: true, timeout: 600000 }) +``` + +**重要**： + +* 必须指定 `timeout: 600000`，否则默认 30 秒会导致过早超时。 +* 如果 10 分钟后仍未完成，继续使用 `TaskOutput` 轮询，**切勿终止进程**。 +* 如果因超时而跳过等待，**必须调用 `AskUserQuestion` 询问用户是继续等待还是终止任务。切勿直接终止。** + +*** + +## 沟通指南 + +1. 回复以模式标签 `[Mode: X]` 开头，初始为 `[Mode: Research]`。 +2. 遵循严格顺序：`Research → Ideation → Plan → Execute → Optimize → Review`。 +3. 每个阶段完成后请求用户确认。 +4. 当评分 < 7 或用户不批准时强制停止。 +5. 需要时（例如确认/选择/批准）使用 `AskUserQuestion` 工具进行用户交互。 + +*** + +## 执行工作流程 + +**任务描述**：$ARGUMENTS + +### 阶段 1：研究与分析 + +`[Mode: Research]` - 理解需求并收集上下文： + +1. **提示词增强**：调用 `mcp__ace-tool__enhance_prompt`，**将所有后续对 Codex/Gemini 的调用中的原始 $ARGUMENTS 替换为增强后的结果** +2. **上下文检索**：调用 `mcp__ace-tool__search_context` +3. **需求完整性评分** (0-10)： + * 目标清晰度 (0-3)，预期成果 (0-3)，范围边界 (0-2)，约束条件 (0-2) + * ≥7：继续 | <7：停止，询问澄清问题 + +### 阶段 2：解决方案构思 + +`[Mode: Ideation]` - 多模型并行分析： + +**并行调用** (`run_in_background: true`)： + +* Codex：使用分析器提示词，输出技术可行性、解决方案、风险 +* Gemini：使用分析器提示词，输出 UI 可行性、解决方案、UX 评估 + +使用 `TaskOutput` 等待结果。**保存 SESSION\_ID** (`CODEX_SESSION` 和 `GEMINI_SESSION`)。 + +**遵循上方 `Multi-Model Call Specification` 中的 `IMPORTANT` 说明** + +综合两项分析，输出解决方案比较（至少 2 个选项），等待用户选择。 + +### 阶段 3：详细规划 + +`[Mode: Plan]` - 多模型协作规划： + +**并行调用**（使用 `resume ` 恢复会话）： + +* Codex：使用架构师提示词 + `resume $CODEX_SESSION`，输出后端架构 +* Gemini：使用架构师提示词 + `resume $GEMINI_SESSION`，输出前端架构 + +使用 `TaskOutput` 等待结果。 + +**遵循上方 `Multi-Model Call Specification` 中的 `IMPORTANT` 说明** + +**Claude 综合**：采纳 Codex 后端计划 + Gemini 前端计划，在用户批准后保存到 `.claude/plan/task-name.md`。 + +### 阶段 4：实施 + +`[Mode: Execute]` - 代码开发： + +* 严格遵循批准的计划 +* 遵循现有项目代码标准 +* 在关键里程碑请求反馈 + +### 阶段 5：代码优化 + +`[Mode: Optimize]` - 多模型并行审查： + +**并行调用**： + +* Codex：使用审查者提示词，关注安全性、性能、错误处理 +* Gemini：使用审查者提示词，关注可访问性、设计一致性 + +使用 `TaskOutput` 等待结果。整合审查反馈，在用户确认后执行优化。 + +**遵循上方 `Multi-Model Call Specification` 中的 `IMPORTANT` 说明** + +### 阶段 6：质量审查 + +`[Mode: Review]` - 最终评估： + +* 对照计划检查完成情况 +* 运行测试以验证功能 +* 报告问题和建议 +* 请求最终用户确认 + +*** + +## 关键规则 + +1. 阶段顺序不可跳过（除非用户明确指示） +2. 外部模型**对文件系统零写入权限**，所有修改由 Claude 执行 +3. 当评分 < 7 或用户不批准时**强制停止** diff --git a/docs/zh-CN/commands/pm2.md b/docs/zh-CN/commands/pm2.md new file mode 100644 index 0000000..080094f --- /dev/null +++ b/docs/zh-CN/commands/pm2.md @@ -0,0 +1,283 @@ +# PM2 初始化 + +自动分析项目并生成 PM2 服务命令。 + +**命令**: `$ARGUMENTS` + +*** + +## 工作流程 + +1. 检查 PM2（如果缺失，通过 `npm install -g pm2` 安装） +2. 扫描项目以识别服务（前端/后端/数据库） +3. 生成配置文件和各命令文件 + +*** + +## 服务检测 + +| 类型 | 检测方式 | 默认端口 | +|------|-----------|--------------| +| Vite | vite.config.\* | 5173 | +| Next.js | next.config.\* | 3000 | +| Nuxt | nuxt.config.\* | 3000 | +| CRA | package.json 中的 react-scripts | 3000 | +| Express/Node | server/backend/api 目录 + package.json | 3000 | +| FastAPI/Flask | requirements.txt / pyproject.toml | 8000 | +| Go | go.mod / main.go | 8080 | + +**端口检测优先级**: 用户指定 > .env 文件 > 配置文件 > 脚本参数 > 默认端口 + +*** + +## 生成的文件 + +``` +project/ +├── ecosystem.config.cjs # PM2 config +├── {backend}/start.cjs # Python wrapper (if applicable) +└── .claude/ + ├── commands/ + │ ├── pm2-all.md # Start all + monit + │ ├── pm2-all-stop.md # Stop all + │ ├── pm2-all-restart.md # Restart all + │ ├── pm2-{port}.md # Start single + logs + │ ├── pm2-{port}-stop.md # Stop single + │ ├── pm2-{port}-restart.md # Restart single + │ ├── pm2-logs.md # View all logs + │ └── pm2-status.md # View status + └── scripts/ + ├── pm2-logs-{port}.ps1 # Single service logs + └── pm2-monit.ps1 # PM2 monitor +``` + +*** + +## Windows 配置（重要） + +### ecosystem.config.cjs + +**必须使用 `.cjs` 扩展名** + +```javascript +module.exports = { + apps: [ + // Node.js (Vite/Next/Nuxt) + { + name: 'project-3000', + cwd: './packages/web', + script: 'node_modules/vite/bin/vite.js', + args: '--port 3000', + interpreter: 'C:/Program Files/nodejs/node.exe', + env: { NODE_ENV: 'development' } + }, + // Python + { + name: 'project-8000', + cwd: './backend', + script: 'start.cjs', + interpreter: 'C:/Program Files/nodejs/node.exe', + env: { PYTHONUNBUFFERED: '1' } + } + ] +} +``` + +**框架脚本路径:** + +| 框架 | script | args | +|-----------|--------|------| +| Vite | `node_modules/vite/bin/vite.js` | `--port {port}` | +| Next.js | `node_modules/next/dist/bin/next` | `dev -p {port}` | +| Nuxt | `node_modules/nuxt/bin/nuxt.mjs` | `dev --port {port}` | +| Express | `src/index.js` 或 `server.js` | - | + +### Python 包装脚本 (start.cjs) + +```javascript +const { spawn } = require('child_process'); +const proc = spawn('python', ['-m', 'uvicorn', 'app.main:app', '--host', '0.0.0.0', '--port', '8000', '--reload'], { + cwd: __dirname, stdio: 'inherit', windowsHide: true +}); +proc.on('close', (code) => process.exit(code)); +``` + +*** + +## 命令文件模板（最简内容） + +### pm2-all.md (启动所有 + 监控) + +````markdown +启动所有服务并打开 PM2 监控器。 +```bash +cd "{PROJECT_ROOT}" && pm2 start ecosystem.config.cjs && start wt.exe -d "{PROJECT_ROOT}" pwsh -NoExit -c "pm2 monit" +``` +```` + +### pm2-all-stop.md + +````markdown +停止所有服务。 +```bash +cd "{PROJECT_ROOT}" && pm2 stop all +``` +```` + +### pm2-all-restart.md + +````markdown +重启所有服务。 +```bash +cd "{PROJECT_ROOT}" && pm2 restart all +``` +```` + +### pm2-{port}.md (启动单个 + 日志) + +````markdown +启动 {name} ({port}) 并打开日志。 +```bash +cd "{PROJECT_ROOT}" && pm2 start ecosystem.config.cjs --only {name} && start wt.exe -d "{PROJECT_ROOT}" pwsh -NoExit -c "pm2 logs {name}" +``` +```` + +### pm2-{port}-stop.md + +````markdown +停止 {name} ({port})。 +```bash +cd "{PROJECT_ROOT}" && pm2 stop {name} +``` +```` + +### pm2-{port}-restart.md + +````markdown +重启 {name} ({port})。 +```bash +cd "{PROJECT_ROOT}" && pm2 restart {name} +``` +```` + +### pm2-logs.md + +````markdown +查看所有 PM2 日志。 +```bash +cd "{PROJECT_ROOT}" && pm2 logs +``` +```` + +### pm2-status.md + +````markdown +查看 PM2 状态。 +```bash +cd "{PROJECT_ROOT}" && pm2 status +``` +```` + +### PowerShell 脚本 (pm2-logs-{port}.ps1) + +```powershell +Set-Location "{PROJECT_ROOT}" +pm2 logs {name} +``` + +### PowerShell 脚本 (pm2-monit.ps1) + +```powershell +Set-Location "{PROJECT_ROOT}" +pm2 monit +``` + +*** + +## 关键规则 + +1. **配置文件**: `ecosystem.config.cjs` (不是 .js) +2. **Node.js**: 直接指定 bin 路径 + 解释器 +3. **Python**: Node.js 包装脚本 + `windowsHide: true` +4. **打开新窗口**: `start wt.exe -d "{path}" pwsh -NoExit -c "command"` +5. **最简内容**: 每个命令文件只有 1-2 行描述 + bash 代码块 +6. **直接执行**: 无需 AI 解析，直接运行 bash 命令 + +*** + +## 执行 + +基于 `$ARGUMENTS`，执行初始化： + +1. 扫描项目服务 +2. 生成 `ecosystem.config.cjs` +3. 为 Python 服务生成 `{backend}/start.cjs`（如果适用） +4. 在 `.claude/commands/` 中生成命令文件 +5. 在 `.claude/scripts/` 中生成脚本文件 +6. **更新项目 CLAUDE.md**，添加 PM2 信息（见下文） +7. **显示完成摘要**，包含终端命令 + +*** + +## 初始化后：更新 CLAUDE.md + +生成文件后，将 PM2 部分追加到项目的 `CLAUDE.md`（如果不存在则创建）： + +````markdown +## PM2 服务 + +| 端口 | 名称 | 类型 | +|------|------|------| +| {port} | {name} | {type} | + +**终端命令：** +```bash +pm2 start ecosystem.config.cjs # First time +pm2 start all # After first time +pm2 stop all / pm2 restart all +pm2 start {name} / pm2 stop {name} +pm2 logs / pm2 status / pm2 monit +pm2 save # Save process list +pm2 resurrect # Restore saved list +``` +```` + +**更新 CLAUDE.md 的规则：** + +* 如果存在 PM2 部分，替换它 +* 如果不存在，追加到末尾 +* 保持内容精简且必要 + +*** + +## 初始化后：显示摘要 + +所有文件生成后，输出： + +``` +## PM2 Init Complete + +**Services:** + +| Port | Name | Type | +|------|------|------| +| {port} | {name} | {type} | + +**Claude Commands:** /pm2-all, /pm2-all-stop, /pm2-{port}, /pm2-{port}-stop, /pm2-logs, /pm2-status + +**Terminal Commands:** +## First time (with config file) +pm2 start ecosystem.config.cjs && pm2 save + +## After first time (simplified) +pm2 start all # Start all +pm2 stop all # Stop all +pm2 restart all # Restart all +pm2 start {name} # Start single +pm2 stop {name} # Stop single +pm2 logs # View logs +pm2 monit # Monitor panel +pm2 resurrect # Restore saved processes + +**Tip:** Run `pm2 save` after first start to enable simplified commands. +``` diff --git a/docs/zh-CN/rules/README.md b/docs/zh-CN/rules/README.md new file mode 100644 index 0000000..c79a2ea --- /dev/null +++ b/docs/zh-CN/rules/README.md @@ -0,0 +1,80 @@ +# 规则 + +## 结构 + +规则被组织为一个**通用**层加上**语言特定**的目录： + +``` +rules/ +├── common/ # Language-agnostic principles (always install) +│ ├── coding-style.md +│ ├── git-workflow.md +│ ├── testing.md +│ ├── performance.md +│ ├── patterns.md +│ ├── hooks.md +│ ├── agents.md +│ └── security.md +├── typescript/ # TypeScript/JavaScript specific +├── python/ # Python specific +└── golang/ # Go specific +``` + +* **common/** 包含通用原则 —— 没有语言特定的代码示例。 +* **语言目录** 通过框架特定的模式、工具和代码示例来扩展通用规则。每个文件都引用其对应的通用文件。 + +## 安装 + +### 选项 1：安装脚本（推荐） + +```bash +# Install common + one or more language-specific rule sets +./install.sh typescript +./install.sh python +./install.sh golang + +# Install multiple languages at once +./install.sh typescript python +``` + +### 选项 2：手动安装 + +> **重要提示：** 复制整个目录 —— 不要使用 `/*` 将其扁平化。 +> 通用目录和语言特定目录包含同名的文件。 +> 将它们扁平化到一个目录会导致语言特定的文件覆盖通用规则，并破坏语言特定文件使用的相对 `../common/` 引用。 + +```bash +# Install common rules (required for all projects) +cp -r rules/common ~/.claude/rules/common + +# Install language-specific rules based on your project's tech stack +cp -r rules/typescript ~/.claude/rules/typescript +cp -r rules/python ~/.claude/rules/python +cp -r rules/golang ~/.claude/rules/golang + +# Attention ! ! ! Configure according to your actual project requirements; the configuration here is for reference only. +``` + +## 规则与技能 + +* **规则** 定义广泛适用的标准、约定和检查清单（例如，“80% 的测试覆盖率”、“没有硬编码的密钥”）。 +* **技能**（`skills/` 目录）为特定任务提供深入、可操作的参考材料（例如，`python-patterns`，`golang-testing`）。 + +语言特定的规则文件会在适当的地方引用相关的技能。规则告诉你*要做什么*；技能告诉你*如何去做*。 + +## 添加新语言 + +要添加对新语言的支持（例如，`rust/`）： + +1. 创建一个 `rules/rust/` 目录 +2. 添加扩展通用规则的文件： + * `coding-style.md` —— 格式化工具、习惯用法、错误处理模式 + * `testing.md` —— 测试框架、覆盖率工具、测试组织 + * `patterns.md` —— 语言特定的设计模式 + * `hooks.md` —— 用于格式化工具、代码检查器、类型检查器的 PostToolUse 钩子 + * `security.md` —— 密钥管理、安全扫描工具 +3. 每个文件应以以下内容开头： + ``` + > 此文件通过 <语言> 特定内容扩展了 [common/xxx.md](../common/xxx.md)。 + ``` +4. 如果现有技能可用，则引用它们，或者在 `skills/` 下创建新的技能。 diff --git a/docs/zh-CN/rules/coding-style.md b/docs/zh-CN/rules/coding-style.md deleted file mode 100644 index 62ce2dd..0000000 --- a/docs/zh-CN/rules/coding-style.md +++ /dev/null @@ -1,72 +0,0 @@ -# 编码风格 - -## 不可变性（关键） - -始终创建新对象，切勿修改： - -```javascript -// WRONG: Mutation -function updateUser(user, name) { - user.name = name // MUTATION! - return user -} - -// CORRECT: Immutability -function updateUser(user, name) { - return { - ...user, - name - } -} -``` - -## 文件组织 - -多个小文件 > 少数大文件： - -* 高内聚，低耦合 -* 典型 200-400 行，最多 800 行 -* 从大型组件中提取实用工具 -* 按功能/领域组织，而非按类型 - -## 错误处理 - -始终全面处理错误： - -```typescript -try { - const result = await riskyOperation() - return result -} catch (error) { - console.error('Operation failed:', error) - throw new Error('Detailed user-friendly message') -} -``` - -## 输入验证 - -始终验证用户输入： - -```typescript -import { z } from 'zod' - -const schema = z.object({ - email: z.string().email(), - age: z.number().int().min(0).max(150) -}) - -const validated = schema.parse(input) -``` - -## 代码质量检查清单 - -在标记工作完成之前： - -* \[ ] 代码可读且命名良好 -* \[ ] 函数短小（<50 行） -* \[ ] 文件专注（<800 行） -* \[ ] 无深层嵌套（>4 层） -* \[ ] 正确的错误处理 -* \[ ] 无 console.log 语句 -* \[ ] 无硬编码值 -* \[ ] 无修改（使用不可变模式） diff --git a/docs/zh-CN/rules/agents.md b/docs/zh-CN/rules/common/agents.md similarity index 80% rename from docs/zh-CN/rules/agents.md rename to docs/zh-CN/rules/common/agents.md index be1503c..f94a750 100644 --- a/docs/zh-CN/rules/agents.md +++ b/docs/zh-CN/rules/common/agents.md @@ -30,14 +30,15 @@ 对于独立操作，**始终**使用并行任务执行： ```markdown -# GOOD: Parallel execution -Launch 3 agents in parallel: -1. Agent 1: Security analysis of auth.ts -2. Agent 2: Performance review of cache system -3. Agent 3: Type checking of utils.ts +# 良好：并行执行 +同时启动 3 个智能体： +1. 智能体 1：认证模块的安全分析 +2. 智能体 2：缓存系统的性能审查 +3. 智能体 3：工具类的类型检查 + +# 不良：不必要的顺序执行 +先智能体 1，然后智能体 2，最后智能体 3 -# BAD: Sequential when unnecessary -First agent 1, then agent 2, then agent 3 ``` ## 多视角分析 diff --git a/docs/zh-CN/rules/common/coding-style.md b/docs/zh-CN/rules/common/coding-style.md new file mode 100644 index 0000000..58db304 --- /dev/null +++ b/docs/zh-CN/rules/common/coding-style.md @@ -0,0 +1,52 @@ +# 编码风格 + +## 不可变性（关键） + +始终创建新对象，绝不改变现有对象： + +``` +// Pseudocode +WRONG: modify(original, field, value) → changes original in-place +CORRECT: update(original, field, value) → returns new copy with change +``` + +理由：不可变数据可以防止隐藏的副作用，使调试更容易，并支持安全的并发。 + +## 文件组织 + +多个小文件 > 少数大文件： + +* 高内聚，低耦合 +* 通常 200-400 行，最多 800 行 +* 从大型模块中提取实用工具 +* 按功能/领域组织，而不是按类型组织 + +## 错误处理 + +始终全面处理错误： + +* 在每个层级明确处理错误 +* 在面向用户的代码中提供用户友好的错误消息 +* 在服务器端记录详细的错误上下文 +* 绝不默默地忽略错误 + +## 输入验证 + +始终在系统边界处进行验证： + +* 在处理前验证所有用户输入 +* 在可用时使用基于模式的验证 +* 快速失败并提供清晰的错误消息 +* 绝不信任外部数据（API 响应、用户输入、文件内容） + +## 代码质量检查清单 + +在标记工作完成之前： + +* \[ ] 代码可读且命名良好 +* \[ ] 函数短小（<50 行） +* \[ ] 文件专注（<800 行） +* \[ ] 没有深度嵌套（>4 层） +* \[ ] 正确的错误处理 +* \[ ] 没有硬编码的值（使用常量或配置） +* \[ ] 没有突变（使用不可变模式） diff --git a/docs/zh-CN/rules/git-workflow.md b/docs/zh-CN/rules/common/git-workflow.md similarity index 100% rename from docs/zh-CN/rules/git-workflow.md rename to docs/zh-CN/rules/common/git-workflow.md diff --git a/docs/zh-CN/rules/hooks.md b/docs/zh-CN/rules/common/hooks.md similarity index 52% rename from docs/zh-CN/rules/hooks.md rename to docs/zh-CN/rules/common/hooks.md index 7de9933..91c1421 100644 --- a/docs/zh-CN/rules/hooks.md +++ b/docs/zh-CN/rules/common/hooks.md @@ -6,25 +6,6 @@ * **PostToolUse**：工具执行后（自动格式化、检查） * **Stop**：会话结束时（最终验证） -## 当前 Hooks（位于 ~/.claude/settings.json） - -### PreToolUse - -* **tmux 提醒**：建议对长时间运行的命令（npm、pnpm、yarn、cargo 等）使用 tmux -* **git push 审查**：推送前在 Zed 中打开进行审查 -* **文档拦截器**：阻止创建不必要的 .md/.txt 文件 - -### PostToolUse - -* **PR 创建**：记录 PR URL 和 GitHub Actions 状态 -* **Prettier**：编辑后自动格式化 JS/TS 文件 -* **TypeScript 检查**：编辑 .ts/.tsx 文件后运行 tsc -* **console.log 警告**：警告编辑的文件中存在 console.log - -### Stop - -* **console.log 审计**：会话结束前检查所有修改的文件中是否存在 console.log - ## 自动接受权限 谨慎使用： diff --git a/docs/zh-CN/rules/common/patterns.md b/docs/zh-CN/rules/common/patterns.md new file mode 100644 index 0000000..d163ec0 --- /dev/null +++ b/docs/zh-CN/rules/common/patterns.md @@ -0,0 +1,34 @@ +# 常见模式 + +## 骨架项目 + +当实现新功能时： + +1. 搜索经过实战检验的骨架项目 +2. 使用并行代理评估选项： + * 安全性评估 + * 可扩展性分析 + * 相关性评分 + * 实施规划 +3. 克隆最佳匹配作为基础 +4. 在已验证的结构内迭代 + +## 设计模式 + +### 仓库模式 + +将数据访问封装在一个一致的接口之后： + +* 定义标准操作：findAll, findById, create, update, delete +* 具体实现处理存储细节（数据库、API、文件等） +* 业务逻辑依赖于抽象接口，而非存储机制 +* 便于轻松切换数据源，并使用模拟对象简化测试 + +### API 响应格式 + +对所有 API 响应使用一致的信封格式： + +* 包含一个成功/状态指示器 +* 包含数据载荷（出错时可为空） +* 包含一个错误消息字段（成功时可为空） +* 为分页响应包含元数据（总数、页码、限制） diff --git a/docs/zh-CN/rules/performance.md b/docs/zh-CN/rules/common/performance.md similarity index 61% rename from docs/zh-CN/rules/performance.md rename to docs/zh-CN/rules/common/performance.md index 5f4fc1f..55297c1 100644 --- a/docs/zh-CN/rules/performance.md +++ b/docs/zh-CN/rules/common/performance.md @@ -35,14 +35,23 @@ * 文档更新 * 简单的错误修复 -## Ultrathink + 计划模式 +## 扩展思考 + 计划模式 + +扩展思考默认启用，最多保留 31,999 个令牌用于内部推理。 + +通过以下方式控制扩展思考： + +* **切换**：Option+T (macOS) / Alt+T (Windows/Linux) +* **配置**：在 `~/.claude/settings.json` 中设置 `alwaysThinkingEnabled` +* **预算上限**：`export MAX_THINKING_TOKENS=10000` +* **详细模式**：Ctrl+O 查看思考输出 对于需要深度推理的复杂任务: -1. 使用 `ultrathink` 进行增强思考 -2. 启用**计划模式**以获得结构化方法 -3. 通过多轮批判性评审来"发动引擎" -4. 使用拆分角色的子智能体进行多样化分析 +1. 确保扩展思考已启用（默认开启） +2. 启用 **计划模式** 以获得结构化方法 +3. 使用多轮批判进行彻底分析 +4. 使用分割角色子代理以获得多元视角 ## 构建故障排除 diff --git a/docs/zh-CN/rules/security.md b/docs/zh-CN/rules/common/security.md similarity index 75% rename from docs/zh-CN/rules/security.md rename to docs/zh-CN/rules/common/security.md index 8d9b1f8..c74ab55 100644 --- a/docs/zh-CN/rules/security.md +++ b/docs/zh-CN/rules/common/security.md @@ -15,17 +15,10 @@ ## 密钥管理 -```typescript -// NEVER: Hardcoded secrets -const apiKey = "sk-proj-xxxxx" - -// ALWAYS: Environment variables -const apiKey = process.env.OPENAI_API_KEY - -if (!apiKey) { - throw new Error('OPENAI_API_KEY not configured') -} -``` +* 切勿在源代码中硬编码密钥 +* 始终使用环境变量或密钥管理器 +* 在启动时验证所需的密钥是否存在 +* 轮换任何可能已泄露的密钥 ## 安全响应协议 diff --git a/docs/zh-CN/rules/testing.md b/docs/zh-CN/rules/common/testing.md similarity index 76% rename from docs/zh-CN/rules/testing.md rename to docs/zh-CN/rules/common/testing.md index 62427f7..6544b60 100644 --- a/docs/zh-CN/rules/testing.md +++ b/docs/zh-CN/rules/common/testing.md @@ -6,7 +6,7 @@ 1. **单元测试** - 单个函数、工具、组件 2. **集成测试** - API 端点、数据库操作 -3. **端到端测试** - 关键用户流程 (Playwright) +3. **端到端测试** - 关键用户流程（根据语言选择框架） ## 测试驱动开发 @@ -28,5 +28,4 @@ ## 代理支持 -* **tdd-guide** - 主动用于新功能，强制执行先写测试 -* **e2e-runner** - Playwright 端到端测试专家 +* **tdd-guide** - 主动用于新功能，强制执行测试优先 diff --git a/docs/zh-CN/rules/golang/coding-style.md b/docs/zh-CN/rules/golang/coding-style.md new file mode 100644 index 0000000..e696bd9 --- /dev/null +++ b/docs/zh-CN/rules/golang/coding-style.md @@ -0,0 +1,26 @@ +# Go 编码风格 + +> 本文件在 [common/coding-style.md](../common/coding-style.md) 的基础上，扩展了 Go 语言的特定内容。 + +## 格式化 + +* **gofmt** 和 **goimports** 是强制性的 —— 无需进行风格辩论 + +## 设计原则 + +* 接受接口，返回结构体 +* 保持接口小巧（1-3 个方法） + +## 错误处理 + +始终用上下文包装错误： + +```go +if err != nil { + return fmt.Errorf("failed to create user: %w", err) +} +``` + +## 参考 + +查看技能：`golang-patterns` 以获取全面的 Go 语言惯用法和模式。 diff --git a/docs/zh-CN/rules/golang/hooks.md b/docs/zh-CN/rules/golang/hooks.md new file mode 100644 index 0000000..0b065d1 --- /dev/null +++ b/docs/zh-CN/rules/golang/hooks.md @@ -0,0 +1,11 @@ +# Go 钩子 + +> 本文件通过 Go 特定内容扩展了 [common/hooks.md](../common/hooks.md)。 + +## PostToolUse 钩子 + +在 `~/.claude/settings.json` 中配置： + +* **gofmt/goimports**：编辑后自动格式化 `.go` 文件 +* **go vet**：编辑 `.go` 文件后运行静态分析 +* **staticcheck**：对修改的包运行扩展静态检查 diff --git a/docs/zh-CN/rules/golang/patterns.md b/docs/zh-CN/rules/golang/patterns.md new file mode 100644 index 0000000..8fefdc9 --- /dev/null +++ b/docs/zh-CN/rules/golang/patterns.md @@ -0,0 +1,39 @@ +# Go 模式 + +> 本文档在 [common/patterns.md](../common/patterns.md) 的基础上扩展了 Go 语言特定的内容。 + +## 函数式选项 + +```go +type Option func(*Server) + +func WithPort(port int) Option { + return func(s *Server) { s.port = port } +} + +func NewServer(opts ...Option) *Server { + s := &Server{port: 8080} + for _, opt := range opts { + opt(s) + } + return s +} +``` + +## 小接口 + +在接口被使用的地方定义它们，而不是在它们被实现的地方。 + +## 依赖注入 + +使用构造函数来注入依赖： + +```go +func NewUserService(repo UserRepository, logger Logger) *UserService { + return &UserService{repo: repo, logger: logger} +} +``` + +## 参考 + +有关全面的 Go 模式（包括并发、错误处理和包组织），请参阅技能：`golang-patterns`。 diff --git a/docs/zh-CN/rules/golang/security.md b/docs/zh-CN/rules/golang/security.md new file mode 100644 index 0000000..46f5634 --- /dev/null +++ b/docs/zh-CN/rules/golang/security.md @@ -0,0 +1,28 @@ +# Go 安全 + +> 此文件基于 [common/security.md](../common/security.md) 扩展了 Go 特定内容。 + +## 密钥管理 + +```go +apiKey := os.Getenv("OPENAI_API_KEY") +if apiKey == "" { + log.Fatal("OPENAI_API_KEY not configured") +} +``` + +## 安全扫描 + +* 使用 **gosec** 进行静态安全分析： + ```bash + gosec ./... + ``` + +## 上下文与超时 + +始终使用 `context.Context` 进行超时控制： + +```go +ctx, cancel := context.WithTimeout(ctx, 5*time.Second) +defer cancel() +``` diff --git a/docs/zh-CN/rules/golang/testing.md b/docs/zh-CN/rules/golang/testing.md new file mode 100644 index 0000000..80a1f54 --- /dev/null +++ b/docs/zh-CN/rules/golang/testing.md @@ -0,0 +1,25 @@ +# Go 测试 + +> 本文档在 [common/testing.md](../common/testing.md) 的基础上扩展了 Go 特定的内容。 + +## 框架 + +使用标准的 `go test` 并采用 **表格驱动测试**。 + +## 竞态检测 + +始终使用 `-race` 标志运行： + +```bash +go test -race ./... +``` + +## 覆盖率 + +```bash +go test -cover ./... +``` + +## 参考 + +查看技能：`golang-testing` 以获取详细的 Go 测试模式和辅助工具。 diff --git a/docs/zh-CN/rules/python/coding-style.md b/docs/zh-CN/rules/python/coding-style.md new file mode 100644 index 0000000..a649309 --- /dev/null +++ b/docs/zh-CN/rules/python/coding-style.md @@ -0,0 +1,37 @@ +# Python 编码风格 + +> 本文件在 [common/coding-style.md](../common/coding-style.md) 的基础上扩展了 Python 特定的内容。 + +## 标准 + +* 遵循 **PEP 8** 规范 +* 在所有函数签名上使用 **类型注解** + +## 不变性 + +优先使用不可变数据结构： + +```python +from dataclasses import dataclass + +@dataclass(frozen=True) +class User: + name: str + email: str + +from typing import NamedTuple + +class Point(NamedTuple): + x: float + y: float +``` + +## 格式化 + +* 使用 **black** 进行代码格式化 +* 使用 **isort** 进行导入排序 +* 使用 **ruff** 进行代码检查 + +## 参考 + +查看技能：`python-patterns` 以获取全面的 Python 惯用法和模式。 diff --git a/docs/zh-CN/rules/python/hooks.md b/docs/zh-CN/rules/python/hooks.md new file mode 100644 index 0000000..2808168 --- /dev/null +++ b/docs/zh-CN/rules/python/hooks.md @@ -0,0 +1,14 @@ +# Python 钩子 + +> 本文档扩展了 [common/hooks.md](../common/hooks.md) 中关于 Python 的特定内容。 + +## PostToolUse 钩子 + +在 `~/.claude/settings.json` 中配置： + +* **black/ruff**：编辑后自动格式化 `.py` 文件 +* **mypy/pyright**：编辑 `.py` 文件后运行类型检查 + +## 警告 + +* 对编辑文件中的 `print()` 语句发出警告（应使用 `logging` 模块替代） diff --git a/docs/zh-CN/rules/python/patterns.md b/docs/zh-CN/rules/python/patterns.md new file mode 100644 index 0000000..fb9aa37 --- /dev/null +++ b/docs/zh-CN/rules/python/patterns.md @@ -0,0 +1,34 @@ +# Python 模式 + +> 本文档扩展了 [common/patterns.md](../common/patterns.md)，补充了 Python 特定的内容。 + +## 协议（鸭子类型） + +```python +from typing import Protocol + +class Repository(Protocol): + def find_by_id(self, id: str) -> dict | None: ... + def save(self, entity: dict) -> dict: ... +``` + +## 数据类作为 DTO + +```python +from dataclasses import dataclass + +@dataclass +class CreateUserRequest: + name: str + email: str + age: int | None = None +``` + +## 上下文管理器与生成器 + +* 使用上下文管理器（`with` 语句）进行资源管理 +* 使用生成器进行惰性求值和内存高效迭代 + +## 参考 + +查看技能：`python-patterns`，了解包括装饰器、并发和包组织在内的综合模式。 diff --git a/docs/zh-CN/rules/python/security.md b/docs/zh-CN/rules/python/security.md new file mode 100644 index 0000000..1b3d1eb --- /dev/null +++ b/docs/zh-CN/rules/python/security.md @@ -0,0 +1,25 @@ +# Python 安全 + +> 本文档基于 [通用安全指南](../common/security.md) 扩展，补充了 Python 相关的内容。 + +## 密钥管理 + +```python +import os +from dotenv import load_dotenv + +load_dotenv() + +api_key = os.environ["OPENAI_API_KEY"] # Raises KeyError if missing +``` + +## 安全扫描 + +* 使用 **bandit** 进行静态安全分析： + ```bash + bandit -r src/ + ``` + +## 参考 + +查看技能：`django-security` 以获取 Django 特定的安全指南（如适用）。 diff --git a/docs/zh-CN/rules/python/testing.md b/docs/zh-CN/rules/python/testing.md new file mode 100644 index 0000000..7d43311 --- /dev/null +++ b/docs/zh-CN/rules/python/testing.md @@ -0,0 +1,33 @@ +# Python 测试 + +> 本文件在 [通用/测试.md](../common/testing.md) 的基础上扩展了 Python 特定的内容。 + +## 框架 + +使用 **pytest** 作为测试框架。 + +## 覆盖率 + +```bash +pytest --cov=src --cov-report=term-missing +``` + +## 测试组织 + +使用 `pytest.mark` 进行测试分类： + +```python +import pytest + +@pytest.mark.unit +def test_calculate_total(): + ... + +@pytest.mark.integration +def test_database_connection(): + ... +``` + +## 参考 + +查看技能：`python-testing` 以获取详细的 pytest 模式和夹具信息。 diff --git a/docs/zh-CN/rules/typescript/coding-style.md b/docs/zh-CN/rules/typescript/coding-style.md new file mode 100644 index 0000000..218081c --- /dev/null +++ b/docs/zh-CN/rules/typescript/coding-style.md @@ -0,0 +1,58 @@ +# TypeScript/JavaScript 编码风格 + +> 本文件基于 [common/coding-style.md](../common/coding-style.md) 扩展，包含 TypeScript/JavaScript 特定内容。 + +## 不可变性 + +使用展开运算符进行不可变更新： + +```typescript +// WRONG: Mutation +function updateUser(user, name) { + user.name = name // MUTATION! + return user +} + +// CORRECT: Immutability +function updateUser(user, name) { + return { + ...user, + name + } +} +``` + +## 错误处理 + +使用 async/await 配合 try-catch： + +```typescript +try { + const result = await riskyOperation() + return result +} catch (error) { + console.error('Operation failed:', error) + throw new Error('Detailed user-friendly message') +} +``` + +## 输入验证 + +使用 Zod 进行基于模式的验证： + +```typescript +import { z } from 'zod' + +const schema = z.object({ + email: z.string().email(), + age: z.number().int().min(0).max(150) +}) + +const validated = schema.parse(input) +``` + +## Console.log + +* 生产代码中不允许出现 `console.log` 语句 +* 请使用适当的日志库替代 +* 查看钩子以进行自动检测 diff --git a/docs/zh-CN/rules/typescript/hooks.md b/docs/zh-CN/rules/typescript/hooks.md new file mode 100644 index 0000000..28dd346 --- /dev/null +++ b/docs/zh-CN/rules/typescript/hooks.md @@ -0,0 +1,15 @@ +# TypeScript/JavaScript 钩子 + +> 此文件扩展了 [common/hooks.md](../common/hooks.md)，并添加了 TypeScript/JavaScript 特有的内容。 + +## PostToolUse 钩子 + +在 `~/.claude/settings.json` 中配置： + +* **Prettier**：编辑后自动格式化 JS/TS 文件 +* **TypeScript 检查**：编辑 `.ts`/`.tsx` 文件后运行 `tsc` +* **console.log 警告**：警告编辑过的文件中存在 `console.log` + +## Stop 钩子 + +* **console.log 审计**：在会话结束前，检查所有修改过的文件中是否存在 `console.log` diff --git a/docs/zh-CN/rules/patterns.md b/docs/zh-CN/rules/typescript/patterns.md similarity index 73% rename from docs/zh-CN/rules/patterns.md rename to docs/zh-CN/rules/typescript/patterns.md index 71178f6..6f039d6 100644 --- a/docs/zh-CN/rules/patterns.md +++ b/docs/zh-CN/rules/typescript/patterns.md @@ -1,4 +1,6 @@ -# 常见模式 +# TypeScript/JavaScript 模式 + +> 此文件在 [common/patterns.md](../common/patterns.md) 的基础上扩展了 TypeScript/JavaScript 特定的内容。 ## API 响应格式 @@ -41,16 +43,3 @@ interface Repository { delete(id: string): Promise } ``` - -## 骨架项目 - -当实现新功能时： - -1. 搜索经过实战检验的骨架项目 -2. 使用并行代理评估选项： - * 安全性评估 - * 可扩展性分析 - * 相关性评分 - * 实施规划 -3. 克隆最佳匹配作为基础 -4. 在已验证的结构内迭代 diff --git a/docs/zh-CN/rules/typescript/security.md b/docs/zh-CN/rules/typescript/security.md new file mode 100644 index 0000000..505b839 --- /dev/null +++ b/docs/zh-CN/rules/typescript/security.md @@ -0,0 +1,21 @@ +# TypeScript/JavaScript 安全 + +> 本文档扩展了 [common/security.md](../common/security.md)，包含了 TypeScript/JavaScript 特定的内容。 + +## 密钥管理 + +```typescript +// NEVER: Hardcoded secrets +const apiKey = "sk-proj-xxxxx" + +// ALWAYS: Environment variables +const apiKey = process.env.OPENAI_API_KEY + +if (!apiKey) { + throw new Error('OPENAI_API_KEY not configured') +} +``` + +## 代理支持 + +* 使用 **security-reviewer** 技能进行全面的安全审计 diff --git a/docs/zh-CN/rules/typescript/testing.md b/docs/zh-CN/rules/typescript/testing.md new file mode 100644 index 0000000..ba1ec0f --- /dev/null +++ b/docs/zh-CN/rules/typescript/testing.md @@ -0,0 +1,11 @@ +# TypeScript/JavaScript 测试 + +> 本文档基于 [common/testing.md](../common/testing.md) 扩展，补充了 TypeScript/JavaScript 特定的内容。 + +## E2E 测试 + +使用 **Playwright** 作为关键用户流程的 E2E 测试框架。 + +## 智能体支持 + +* **e2e-runner** - Playwright E2E 测试专家 diff --git a/docs/zh-CN/skills/configure-ecc/SKILL.md b/docs/zh-CN/skills/configure-ecc/SKILL.md new file mode 100644 index 0000000..7c52292 --- /dev/null +++ b/docs/zh-CN/skills/configure-ecc/SKILL.md @@ -0,0 +1,314 @@ +--- +name: configure-ecc +description: Everything Claude Code 的交互式安装程序 — 引导用户选择并安装技能和规则到用户级或项目级目录，验证路径，并可选择性地优化已安装的文件。 +--- + +# 配置 Everything Claude Code (ECC) + +一个交互式、分步安装向导，用于 Everything Claude Code 项目。使用 `AskUserQuestion` 引导用户选择性安装技能和规则，然后验证正确性并提供优化。 + +## 何时激活 + +* 用户说 "configure ecc"、"install ecc"、"setup everything claude code" 或类似表述 +* 用户想要从此项目中选择性安装技能或规则 +* 用户想要验证或修复现有的 ECC 安装 +* 用户想要为其项目优化已安装的技能或规则 + +## 先决条件 + +此技能必须在激活前对 Claude Code 可访问。有两种引导方式： + +1. **通过插件**: `/plugin install everything-claude-code` — 插件会自动加载此技能 +2. **手动**: 仅将此技能复制到 `~/.claude/skills/configure-ecc/SKILL.md`，然后通过说 "configure ecc" 激活 + +*** + +## 步骤 0：克隆 ECC 仓库 + +在任何安装之前，将最新的 ECC 源代码克隆到 `/tmp`： + +```bash +rm -rf /tmp/everything-claude-code +git clone https://github.com/affaan-m/everything-claude-code.git /tmp/everything-claude-code +``` + +将 `ECC_ROOT=/tmp/everything-claude-code` 设置为所有后续复制操作的源。 + +如果克隆失败（网络问题等），使用 `AskUserQuestion` 要求用户提供现有 ECC 克隆的本地路径。 + +*** + +## 步骤 1：选择安装级别 + +使用 `AskUserQuestion` 询问用户安装位置： + +``` +Question: "Where should ECC components be installed?" +Options: + - "User-level (~/.claude/)" — "Applies to all your Claude Code projects" + - "Project-level (.claude/)" — "Applies only to the current project" + - "Both" — "Common/shared items user-level, project-specific items project-level" +``` + +将选择存储为 `INSTALL_LEVEL`。设置目标目录： + +* 用户级别：`TARGET=~/.claude` +* 项目级别：`TARGET=.claude`（相对于当前项目根目录） +* 两者：`TARGET_USER=~/.claude`，`TARGET_PROJECT=.claude` + +如果目标目录不存在，则创建它们： + +```bash +mkdir -p $TARGET/skills $TARGET/rules +``` + +*** + +## 步骤 2：选择并安装技能 + +### 2a：选择技能类别 + +共有 27 项技能，分为 4 个类别。使用 `AskUserQuestion` 和 `multiSelect: true`： + +``` +Question: "Which skill categories do you want to install?" +Options: + - "Framework & Language" — "Django, Spring Boot, Go, Python, Java, Frontend, Backend patterns" + - "Database" — "PostgreSQL, ClickHouse, JPA/Hibernate patterns" + - "Workflow & Quality" — "TDD, verification, learning, security review, compaction" + - "All skills" — "Install every available skill" +``` + +### 2b：确认单项技能 + +对于每个选定的类别，打印下面的完整技能列表，并要求用户确认或取消选择特定的技能。如果列表超过 4 项，将列表打印为文本，并使用 `AskUserQuestion`，提供一个 "安装所有列出项" 的选项，以及一个 "其他" 选项供用户粘贴特定名称。 + +**类别：框架与语言（16 项技能）** + +| 技能 | 描述 | +|-------|-------------| +| `backend-patterns` | Node.js/Express/Next.js 的后端架构、API 设计、服务器端最佳实践 | +| `coding-standards` | TypeScript、JavaScript、React、Node.js 的通用编码标准 | +| `django-patterns` | Django 架构、使用 DRF 的 REST API、ORM、缓存、信号、中间件 | +| `django-security` | Django 安全：身份验证、CSRF、SQL 注入、XSS 防护 | +| `django-tdd` | 使用 pytest-django、factory\_boy、模拟、覆盖率的 Django 测试 | +| `django-verification` | Django 验证循环：迁移、代码检查、测试、安全扫描 | +| `frontend-patterns` | React、Next.js、状态管理、性能、UI 模式 | +| `golang-patterns` | 地道的 Go 模式、健壮 Go 应用程序的约定 | +| `golang-testing` | Go 测试：表格驱动测试、子测试、基准测试、模糊测试 | +| `java-coding-standards` | Spring Boot 的 Java 编码标准：命名、不可变性、Optional、流 | +| `python-patterns` | Pythonic 惯用法、PEP 8、类型提示、最佳实践 | +| `python-testing` | 使用 pytest、TDD、夹具、模拟、参数化的 Python 测试 | +| `springboot-patterns` | Spring Boot 架构、REST API、分层服务、缓存、异步 | +| `springboot-security` | Spring Security：身份验证/授权、验证、CSRF、密钥、速率限制 | +| `springboot-tdd` | 使用 JUnit 5、Mockito、MockMvc、Testcontainers 的 Spring Boot TDD | +| `springboot-verification` | Spring Boot 验证：构建、静态分析、测试、安全扫描 | + +**类别：数据库（3 项技能）** + +| 技能 | 描述 | +|-------|-------------| +| `clickhouse-io` | ClickHouse 模式、查询优化、分析、数据工程 | +| `jpa-patterns` | JPA/Hibernate 实体设计、关系、查询优化、事务 | +| `postgres-patterns` | PostgreSQL 查询优化、模式设计、索引、安全 | + +**类别：工作流与质量（8 项技能）** + +| 技能 | 描述 | +|-------|-------------| +| `continuous-learning` | 从会话中自动提取可重用模式作为习得技能 | +| `continuous-learning-v2` | 基于本能的学习，带有置信度评分，演变为技能/命令/代理 | +| `eval-harness` | 用于评估驱动开发 (EDD) 的正式评估框架 | +| `iterative-retrieval` | 用于子代理上下文问题的渐进式上下文优化 | +| `security-review` | 安全检查清单：身份验证、输入、密钥、API、支付功能 | +| `strategic-compact` | 在逻辑间隔处建议手动上下文压缩 | +| `tdd-workflow` | 强制要求 TDD，覆盖率 80% 以上：单元测试、集成测试、端到端测试 | +| `verification-loop` | 验证和质量循环模式 | + +**独立技能** + +| 技能 | 描述 | +|-------|-------------| +| `project-guidelines-example` | 用于创建项目特定技能的模板 | + +### 2c：执行安装 + +对于每个选定的技能，复制整个技能目录： + +```bash +cp -r $ECC_ROOT/skills/ $TARGET/skills/ +``` + +注意：`continuous-learning` 和 `continuous-learning-v2` 有额外的文件（config.json、钩子、脚本）——确保复制整个目录，而不仅仅是 SKILL.md。 + +*** + +## 步骤 3：选择并安装规则 + +使用 `AskUserQuestion` 和 `multiSelect: true`： + +``` +Question: "Which rule sets do you want to install?" +Options: + - "Common rules (Recommended)" — "Language-agnostic principles: coding style, git workflow, testing, security, etc. (8 files)" + - "TypeScript/JavaScript" — "TS/JS patterns, hooks, testing with Playwright (5 files)" + - "Python" — "Python patterns, pytest, black/ruff formatting (5 files)" + - "Go" — "Go patterns, table-driven tests, gofmt/staticcheck (5 files)" +``` + +执行安装： + +```bash +# Common rules (flat copy into rules/) +cp -r $ECC_ROOT/rules/common/* $TARGET/rules/ + +# Language-specific rules (flat copy into rules/) +cp -r $ECC_ROOT/rules/typescript/* $TARGET/rules/ # if selected +cp -r $ECC_ROOT/rules/python/* $TARGET/rules/ # if selected +cp -r $ECC_ROOT/rules/golang/* $TARGET/rules/ # if selected +``` + +**重要**：如果用户选择了任何特定语言的规则但**没有**选择通用规则，警告他们： + +> "特定语言规则扩展了通用规则。不安装通用规则可能导致覆盖不完整。是否也安装通用规则？" + +*** + +## 步骤 4：安装后验证 + +安装后，执行这些自动化检查： + +### 4a：验证文件存在 + +列出所有已安装的文件并确认它们存在于目标位置： + +```bash +ls -la $TARGET/skills/ +ls -la $TARGET/rules/ +``` + +### 4b：检查路径引用 + +扫描所有已安装的 `.md` 文件中的路径引用： + +```bash +grep -rn "~/.claude/" $TARGET/skills/ $TARGET/rules/ +grep -rn "../common/" $TARGET/rules/ +grep -rn "skills/" $TARGET/skills/ +``` + +**对于项目级别安装**，标记任何对 `~/.claude/` 路径的引用： + +* 如果技能引用 `~/.claude/settings.json` — 这通常没问题（设置始终是用户级别的） +* 如果技能引用 `~/.claude/skills/` 或 `~/.claude/rules/` — 如果仅安装在项目级别，这可能损坏 +* 如果技能通过名称引用另一项技能 — 检查被引用的技能是否也已安装 + +### 4c：检查技能间的交叉引用 + +有些技能会引用其他技能。验证这些依赖关系： + +* `django-tdd` 可能引用 `django-patterns` +* `springboot-tdd` 可能引用 `springboot-patterns` +* `continuous-learning-v2` 引用 `~/.claude/homunculus/` 目录 +* `python-testing` 可能引用 `python-patterns` +* `golang-testing` 可能引用 `golang-patterns` +* 特定语言规则引用其 `common/` 对应项 + +### 4d：报告问题 + +对于发现的每个问题，报告： + +1. **文件**：包含问题引用的文件 +2. **行号**：行号 +3. **问题**：哪里出错了（例如，"引用了 ~/.claude/skills/python-patterns 但 python-patterns 未安装"） +4. **建议的修复**：该怎么做（例如，"安装 python-patterns 技能" 或 "将路径更新为 .claude/skills/"） + +*** + +## 步骤 5：优化已安装文件（可选） + +使用 `AskUserQuestion`： + +``` +Question: "Would you like to optimize the installed files for your project?" +Options: + - "Optimize skills" — "Remove irrelevant sections, adjust paths, tailor to your tech stack" + - "Optimize rules" — "Adjust coverage targets, add project-specific patterns, customize tool configs" + - "Optimize both" — "Full optimization of all installed files" + - "Skip" — "Keep everything as-is" +``` + +### 如果优化技能： + +1. 读取每个已安装的 SKILL.md +2. 询问用户其项目的技术栈是什么（如果尚不清楚） +3. 对于每项技能，建议删除无关部分 +4. 在安装目标处就地编辑 SKILL.md 文件（**不是**源仓库） +5. 修复在步骤 4 中发现的任何路径问题 + +### 如果优化规则： + +1. 读取每个已安装的规则 .md 文件 +2. 询问用户的偏好： + * 测试覆盖率目标（默认 80%） + * 首选的格式化工具 + * Git 工作流约定 + * 安全要求 +3. 在安装目标处就地编辑规则文件 + +**关键**：只修改安装目标（`$TARGET/`）中的文件，**绝不**修改源 ECC 仓库（`$ECC_ROOT/`）中的文件。 + +*** + +## 步骤 6：安装摘要 + +从 `/tmp` 清理克隆的仓库： + +```bash +rm -rf /tmp/everything-claude-code +``` + +然后打印摘要报告： + +``` +## ECC Installation Complete + +### Installation Target +- Level: [user-level / project-level / both] +- Path: [target path] + +### Skills Installed ([count]) +- skill-1, skill-2, skill-3, ... + +### Rules Installed ([count]) +- common (8 files) +- typescript (5 files) +- ... + +### Verification Results +- [count] issues found, [count] fixed +- [list any remaining issues] + +### Optimizations Applied +- [list changes made, or "None"] +``` + +*** + +## 故障排除 + +### "Claude Code 未获取技能" + +* 验证技能目录包含一个 `SKILL.md` 文件（不仅仅是松散的 .md 文件） +* 对于用户级别：检查 `~/.claude/skills//SKILL.md` 是否存在 +* 对于项目级别：检查 `.claude/skills//SKILL.md` 是否存在 + +### "规则不工作" + +* 规则是平面文件，不在子目录中：`$TARGET/rules/coding-style.md`（正确）对比 `$TARGET/rules/common/coding-style.md`（对于平面安装不正确） +* 安装规则后重启 Claude Code + +### "项目级别安装后出现路径引用错误" + +* 有些技能假设 `~/.claude/` 路径。运行步骤 4 验证来查找并修复这些问题。 +* 对于 `continuous-learning-v2`，`~/.claude/homunculus/` 目录始终是用户级别的 — 这是预期的，不是错误。 diff --git a/docs/zh-CN/skills/cpp-testing/SKILL.md b/docs/zh-CN/skills/cpp-testing/SKILL.md new file mode 100644 index 0000000..5601449 --- /dev/null +++ b/docs/zh-CN/skills/cpp-testing/SKILL.md @@ -0,0 +1,322 @@ +--- +name: cpp-testing +description: 仅在编写/更新/修复C++测试、配置GoogleTest/CTest、诊断失败或不稳定的测试，或添加覆盖率/消毒器时使用。 +--- + +# C++ 测试（代理技能） + +针对现代 C++（C++17/20）的代理导向测试工作流，使用 GoogleTest/GoogleMock 和 CMake/CTest。 + +## 使用时机 + +* 编写新的 C++ 测试或修复现有测试 +* 为 C++ 组件设计单元/集成测试覆盖 +* 添加测试覆盖、CI 门控或回归保护 +* 配置 CMake/CTest 工作流以实现一致的执行 +* 调查测试失败或偶发性行为 +* 启用用于内存/竞态诊断的消毒剂 + +### 不适用时机 + +* 在不修改测试的情况下实现新的产品功能 +* 与测试覆盖或失败无关的大规模重构 +* 没有测试回归需要验证的性能调优 +* 非 C++ 项目或非测试任务 + +## 核心概念 + +* **TDD 循环**：红 → 绿 → 重构（先写测试，最小化修复，然后清理）。 +* **隔离**：优先使用依赖注入和仿制品，而非全局状态。 +* **测试布局**：`tests/unit`、`tests/integration`、`tests/testdata`。 +* **Mock 与 Fake**：Mock 用于交互，Fake 用于有状态行为。 +* **CTest 发现**：使用 `gtest_discover_tests()` 进行稳定的测试发现。 +* **CI 信号**：先运行子集，然后使用 `--output-on-failure` 运行完整套件。 + +## TDD 工作流 + +遵循 RED → GREEN → REFACTOR 循环： + +1. **RED**：编写一个捕获新行为的失败测试 +2. **GREEN**：实现最小的更改以使其通过 +3. **REFACTOR**：在测试保持通过的同时进行清理 + +```cpp +// tests/add_test.cpp +#include + +int Add(int a, int b); // Provided by production code. + +TEST(AddTest, AddsTwoNumbers) { // RED + EXPECT_EQ(Add(2, 3), 5); +} + +// src/add.cpp +int Add(int a, int b) { // GREEN + return a + b; +} + +// REFACTOR: simplify/rename once tests pass +``` + +## 代码示例 + +### 基础单元测试 (gtest) + +```cpp +// tests/calculator_test.cpp +#include + +int Add(int a, int b); // Provided by production code. + +TEST(CalculatorTest, AddsTwoNumbers) { + EXPECT_EQ(Add(2, 3), 5); +} +``` + +### 夹具 (gtest) + +```cpp +// tests/user_store_test.cpp +// Pseudocode stub: replace UserStore/User with project types. +#include +#include +#include +#include + +struct User { std::string name; }; +class UserStore { +public: + explicit UserStore(std::string /*path*/) {} + void Seed(std::initializer_list /*users*/) {} + std::optional Find(const std::string &/*name*/) { return User{"alice"}; } +}; + +class UserStoreTest : public ::testing::Test { +protected: + void SetUp() override { + store = std::make_unique(":memory:"); + store->Seed({{"alice"}, {"bob"}}); + } + + std::unique_ptr store; +}; + +TEST_F(UserStoreTest, FindsExistingUser) { + auto user = store->Find("alice"); + ASSERT_TRUE(user.has_value()); + EXPECT_EQ(user->name, "alice"); +} +``` + +### Mock (gmock) + +```cpp +// tests/notifier_test.cpp +#include +#include +#include + +class Notifier { +public: + virtual ~Notifier() = default; + virtual void Send(const std::string &message) = 0; +}; + +class MockNotifier : public Notifier { +public: + MOCK_METHOD(void, Send, (const std::string &message), (override)); +}; + +class Service { +public: + explicit Service(Notifier ¬ifier) : notifier_(notifier) {} + void Publish(const std::string &message) { notifier_.Send(message); } + +private: + Notifier ¬ifier_; +}; + +TEST(ServiceTest, SendsNotifications) { + MockNotifier notifier; + Service service(notifier); + + EXPECT_CALL(notifier, Send("hello")).Times(1); + service.Publish("hello"); +} +``` + +### CMake/CTest 快速入门 + +```cmake +# CMakeLists.txt (excerpt) +cmake_minimum_required(VERSION 3.20) +project(example LANGUAGES CXX) + +set(CMAKE_CXX_STANDARD 20) +set(CMAKE_CXX_STANDARD_REQUIRED ON) + +include(FetchContent) +# Prefer project-locked versions. If using a tag, use a pinned version per project policy. +set(GTEST_VERSION v1.17.0) # Adjust to project policy. +FetchContent_Declare( + googletest + URL https://github.com/google/googletest/archive/refs/tags/${GTEST_VERSION}.zip +) +FetchContent_MakeAvailable(googletest) + +add_executable(example_tests + tests/calculator_test.cpp + src/calculator.cpp +) +target_link_libraries(example_tests GTest::gtest GTest::gmock GTest::gtest_main) + +enable_testing() +include(GoogleTest) +gtest_discover_tests(example_tests) +``` + +```bash +cmake -S . -B build -DCMAKE_BUILD_TYPE=Debug +cmake --build build -j +ctest --test-dir build --output-on-failure +``` + +## 运行测试 + +```bash +ctest --test-dir build --output-on-failure +ctest --test-dir build -R ClampTest +ctest --test-dir build -R "UserStoreTest.*" --output-on-failure +``` + +```bash +./build/example_tests --gtest_filter=ClampTest.* +./build/example_tests --gtest_filter=UserStoreTest.FindsExistingUser +``` + +## 调试失败 + +1. 使用 gtest 过滤器重新运行单个失败的测试。 +2. 在失败的断言周围添加作用域日志记录。 +3. 启用消毒剂后重新运行。 +4. 根本原因修复后，扩展到完整套件。 + +## 覆盖率 + +优先使用目标级别的设置，而非全局标志。 + +```cmake +option(ENABLE_COVERAGE "Enable coverage flags" OFF) + +if(ENABLE_COVERAGE) + if(CMAKE_CXX_COMPILER_ID MATCHES "GNU") + target_compile_options(example_tests PRIVATE --coverage) + target_link_options(example_tests PRIVATE --coverage) + elseif(CMAKE_CXX_COMPILER_ID MATCHES "Clang") + target_compile_options(example_tests PRIVATE -fprofile-instr-generate -fcoverage-mapping) + target_link_options(example_tests PRIVATE -fprofile-instr-generate) + endif() +endif() +``` + +GCC + gcov + lcov： + +```bash +cmake -S . -B build-cov -DENABLE_COVERAGE=ON +cmake --build build-cov -j +ctest --test-dir build-cov +lcov --capture --directory build-cov --output-file coverage.info +lcov --remove coverage.info '/usr/*' --output-file coverage.info +genhtml coverage.info --output-directory coverage +``` + +Clang + llvm-cov： + +```bash +cmake -S . -B build-llvm -DENABLE_COVERAGE=ON -DCMAKE_CXX_COMPILER=clang++ +cmake --build build-llvm -j +LLVM_PROFILE_FILE="build-llvm/default.profraw" ctest --test-dir build-llvm +llvm-profdata merge -sparse build-llvm/default.profraw -o build-llvm/default.profdata +llvm-cov report build-llvm/example_tests -instr-profile=build-llvm/default.profdata +``` + +## 消毒剂 + +```cmake +option(ENABLE_ASAN "Enable AddressSanitizer" OFF) +option(ENABLE_UBSAN "Enable UndefinedBehaviorSanitizer" OFF) +option(ENABLE_TSAN "Enable ThreadSanitizer" OFF) + +if(ENABLE_ASAN) + add_compile_options(-fsanitize=address -fno-omit-frame-pointer) + add_link_options(-fsanitize=address) +endif() +if(ENABLE_UBSAN) + add_compile_options(-fsanitize=undefined -fno-omit-frame-pointer) + add_link_options(-fsanitize=undefined) +endif() +if(ENABLE_TSAN) + add_compile_options(-fsanitize=thread) + add_link_options(-fsanitize=thread) +endif() +``` + +## 偶发性测试防护 + +* 切勿使用 `sleep` 进行同步；使用条件变量或门闩。 +* 为每个测试创建唯一的临时目录并始终清理它们。 +* 避免在单元测试中依赖真实时间、网络或文件系统。 +* 对随机化输入使用确定性种子。 + +## 最佳实践 + +### 应该做 + +* 保持测试的确定性和隔离性 +* 优先使用依赖注入而非全局变量 +* 对前置条件使用 `ASSERT_*`，对多个检查使用 `EXPECT_*` +* 在 CTest 标签或目录中分离单元测试与集成测试 +* 在 CI 中运行消毒剂以进行内存和竞态检测 + +### 不应该做 + +* 不要在单元测试中依赖真实时间或网络 +* 当可以使用条件变量时，不要使用睡眠作为同步手段 +* 不要过度模拟简单的值对象 +* 不要对非关键日志使用脆弱的字符串匹配 + +### 常见陷阱 + +* **使用固定的临时路径** → 为每个测试生成唯一的临时目录并清理它们。 +* **依赖挂钟时间** → 注入时钟或使用模拟时间源。 +* **偶发性并发测试** → 使用条件变量/门闩和有界等待。 +* **隐藏的全局状态** → 在夹具中重置全局状态或移除全局变量。 +* **过度模拟** → 对有状态行为优先使用 Fake，仅对交互进行 Mock。 +* **缺少消毒剂运行** → 在 CI 中添加 ASan/UBSan/TSan 构建。 +* **仅在调试版本上计算覆盖率** → 确保覆盖率目标使用一致的标志。 + +## 可选附录：模糊测试 / 属性测试 + +仅在项目已支持 LLVM/libFuzzer 或属性测试库时使用。 + +* **libFuzzer**：最适合 I/O 最少的纯函数。 +* **RapidCheck**：基于属性的测试，用于验证不变量。 + +最小的 libFuzzer 测试框架（伪代码：替换 ParseConfig）： + +```cpp +#include +#include +#include + +extern "C" int LLVMFuzzerTestOneInput(const uint8_t *data, size_t size) { + std::string input(reinterpret_cast(data), size); + // ParseConfig(input); // project function + return 0; +} +``` + +## GoogleTest 的替代方案 + +* **Catch2**：仅头文件，表达性强的匹配器 +* **doctest**：轻量级，编译开销最小 diff --git a/docs/zh-CN/skills/nutrient-document-processing/SKILL.md b/docs/zh-CN/skills/nutrient-document-processing/SKILL.md new file mode 100644 index 0000000..f5ffd0f --- /dev/null +++ b/docs/zh-CN/skills/nutrient-document-processing/SKILL.md @@ -0,0 +1,165 @@ +--- +name: nutrient-document-processing +description: 使用Nutrient DWS API处理、转换、OCR、提取、编辑、签署和填写文档。支持PDF、DOCX、XLSX、PPTX、HTML和图像文件。 +--- + +# 文档处理 + +使用 [Nutrient DWS Processor API](https://www.nutrient.io/api/) 处理文档。转换格式、提取文本和表格、对扫描文档进行 OCR、编辑 PII、添加水印、数字签名以及填写 PDF 表单。 + +## 设置 + +在 **[nutrient.io](https://dashboard.nutrient.io/sign_up/?product=processor)** 获取一个免费的 API 密钥 + +```bash +export NUTRIENT_API_KEY="pdf_live_..." +``` + +所有请求都以 multipart POST 形式发送到 `https://api.nutrient.io/build`，并附带一个 `instructions` JSON 字段。 + +## 操作 + +### 转换文档 + +```bash +# DOCX to PDF +curl -X POST https://api.nutrient.io/build \ + -H "Authorization: Bearer $NUTRIENT_API_KEY" \ + -F "document.docx=@document.docx" \ + -F 'instructions={"parts":[{"file":"document.docx"}]}' \ + -o output.pdf + +# PDF to DOCX +curl -X POST https://api.nutrient.io/build \ + -H "Authorization: Bearer $NUTRIENT_API_KEY" \ + -F "document.pdf=@document.pdf" \ + -F 'instructions={"parts":[{"file":"document.pdf"}],"output":{"type":"docx"}}' \ + -o output.docx + +# HTML to PDF +curl -X POST https://api.nutrient.io/build \ + -H "Authorization: Bearer $NUTRIENT_API_KEY" \ + -F "index.html=@index.html" \ + -F 'instructions={"parts":[{"html":"index.html"}]}' \ + -o output.pdf +``` + +支持的输入格式：PDF, DOCX, XLSX, PPTX, DOC, XLS, PPT, PPS, PPSX, ODT, RTF, HTML, JPG, PNG, TIFF, HEIC, GIF, WebP, SVG, TGA, EPS。 + +### 提取文本和数据 + +```bash +# Extract plain text +curl -X POST https://api.nutrient.io/build \ + -H "Authorization: Bearer $NUTRIENT_API_KEY" \ + -F "document.pdf=@document.pdf" \ + -F 'instructions={"parts":[{"file":"document.pdf"}],"output":{"type":"text"}}' \ + -o output.txt + +# Extract tables as Excel +curl -X POST https://api.nutrient.io/build \ + -H "Authorization: Bearer $NUTRIENT_API_KEY" \ + -F "document.pdf=@document.pdf" \ + -F 'instructions={"parts":[{"file":"document.pdf"}],"output":{"type":"xlsx"}}' \ + -o tables.xlsx +``` + +### OCR 扫描文档 + +```bash +# OCR to searchable PDF (supports 100+ languages) +curl -X POST https://api.nutrient.io/build \ + -H "Authorization: Bearer $NUTRIENT_API_KEY" \ + -F "scanned.pdf=@scanned.pdf" \ + -F 'instructions={"parts":[{"file":"scanned.pdf"}],"actions":[{"type":"ocr","language":"english"}]}' \ + -o searchable.pdf +``` + +支持语言：通过 ISO 639-2 代码支持 100 多种语言（例如，`eng`, `deu`, `fra`, `spa`, `jpn`, `kor`, `chi_sim`, `chi_tra`, `ara`, `hin`, `rus`）。完整的语言名称如 `english` 或 `german` 也适用。查看 [完整的 OCR 语言表](https://www.nutrient.io/guides/document-engine/ocr/language-support/) 以获取所有支持的代码。 + +### 编辑敏感信息 + +```bash +# Pattern-based (SSN, email) +curl -X POST https://api.nutrient.io/build \ + -H "Authorization: Bearer $NUTRIENT_API_KEY" \ + -F "document.pdf=@document.pdf" \ + -F 'instructions={"parts":[{"file":"document.pdf"}],"actions":[{"type":"redaction","strategy":"preset","strategyOptions":{"preset":"social-security-number"}},{"type":"redaction","strategy":"preset","strategyOptions":{"preset":"email-address"}}]}' \ + -o redacted.pdf + +# Regex-based +curl -X POST https://api.nutrient.io/build \ + -H "Authorization: Bearer $NUTRIENT_API_KEY" \ + -F "document.pdf=@document.pdf" \ + -F 'instructions={"parts":[{"file":"document.pdf"}],"actions":[{"type":"redaction","strategy":"regex","strategyOptions":{"regex":"\\b[A-Z]{2}\\d{6}\\b"}}]}' \ + -o redacted.pdf +``` + +预设：`social-security-number`, `email-address`, `credit-card-number`, `international-phone-number`, `north-american-phone-number`, `date`, `time`, `url`, `ipv4`, `ipv6`, `mac-address`, `us-zip-code`, `vin`。 + +### 添加水印 + +```bash +curl -X POST https://api.nutrient.io/build \ + -H "Authorization: Bearer $NUTRIENT_API_KEY" \ + -F "document.pdf=@document.pdf" \ + -F 'instructions={"parts":[{"file":"document.pdf"}],"actions":[{"type":"watermark","text":"CONFIDENTIAL","fontSize":72,"opacity":0.3,"rotation":-45}]}' \ + -o watermarked.pdf +``` + +### 数字签名 + +```bash +# Self-signed CMS signature +curl -X POST https://api.nutrient.io/build \ + -H "Authorization: Bearer $NUTRIENT_API_KEY" \ + -F "document.pdf=@document.pdf" \ + -F 'instructions={"parts":[{"file":"document.pdf"}],"actions":[{"type":"sign","signatureType":"cms"}]}' \ + -o signed.pdf +``` + +### 填写 PDF 表单 + +```bash +curl -X POST https://api.nutrient.io/build \ + -H "Authorization: Bearer $NUTRIENT_API_KEY" \ + -F "form.pdf=@form.pdf" \ + -F 'instructions={"parts":[{"file":"form.pdf"}],"actions":[{"type":"fillForm","formFields":{"name":"Jane Smith","email":"jane@example.com","date":"2026-02-06"}}]}' \ + -o filled.pdf +``` + +## MCP 服务器（替代方案） + +对于原生工具集成，请使用 MCP 服务器代替 curl： + +```json +{ + "mcpServers": { + "nutrient-dws": { + "command": "npx", + "args": ["-y", "@nutrient-sdk/dws-mcp-server"], + "env": { + "NUTRIENT_DWS_API_KEY": "YOUR_API_KEY", + "SANDBOX_PATH": "/path/to/working/directory" + } + } + } +} +``` + +## 使用场景 + +* 在格式之间转换文档（PDF, DOCX, XLSX, PPTX, HTML, 图像） +* 从 PDF 中提取文本、表格或键值对 +* 对扫描文档或图像进行 OCR +* 在共享文档前编辑 PII +* 为草稿或机密文档添加水印 +* 数字签署合同或协议 +* 以编程方式填写 PDF 表单 + +## 链接 + +* [API 演练场](https://dashboard.nutrient.io/processor-api/playground/) +* [完整 API 文档](https://www.nutrient.io/guides/dws-processor/) +* [代理技能仓库](https://github.com/PSPDFKit-labs/nutrient-agent-skill) +* [npm MCP 服务器](https://www.npmjs.com/package/@nutrient-sdk/dws-mcp-server) diff --git a/docs/zh-CN/skills/security-scan/SKILL.md b/docs/zh-CN/skills/security-scan/SKILL.md new file mode 100644 index 0000000..faeaa18 --- /dev/null +++ b/docs/zh-CN/skills/security-scan/SKILL.md @@ -0,0 +1,171 @@ +--- +name: security-scan +description: 使用AgentShield扫描您的Claude Code配置（.claude/目录），检测安全漏洞、错误配置和注入风险。检查CLAUDE.md、settings.json、MCP服务器、钩子和代理定义。 +--- + +# 安全扫描技能 + +使用 [AgentShield](https://github.com/affaan-m/agentshield) 审计您的 Claude Code 配置中的安全问题。 + +## 何时激活 + +* 设置新的 Claude Code 项目时 +* 修改 `.claude/settings.json`、`CLAUDE.md` 或 MCP 配置后 +* 提交配置更改前 +* 加入具有现有 Claude Code 配置的新代码库时 +* 定期进行安全卫生检查时 + +## 扫描内容 + +| 文件 | 检查项 | +|------|--------| +| `CLAUDE.md` | 硬编码的密钥、自动运行指令、提示词注入模式 | +| `settings.json` | 过于宽松的允许列表、缺失的拒绝列表、危险的绕过标志 | +| `mcp.json` | 有风险的 MCP 服务器、硬编码的环境变量密钥、npx 供应链风险 | +| `hooks/` | 通过 `${file}` 插值导致的命令注入、数据泄露、静默错误抑制 | +| `agents/*.md` | 无限制的工具访问、提示词注入攻击面、缺失的模型规格 | + +## 先决条件 + +必须安装 AgentShield。检查并在需要时安装： + +```bash +# Check if installed +npx ecc-agentshield --version + +# Install globally (recommended) +npm install -g ecc-agentshield + +# Or run directly via npx (no install needed) +npx ecc-agentshield scan . +``` + +## 使用方法 + +### 基础扫描 + +针对当前项目的 `.claude/` 目录运行： + +```bash +# Scan current project +npx ecc-agentshield scan + +# Scan a specific path +npx ecc-agentshield scan --path /path/to/.claude + +# Scan with minimum severity filter +npx ecc-agentshield scan --min-severity medium +``` + +### 输出格式 + +```bash +# Terminal output (default) — colored report with grade +npx ecc-agentshield scan + +# JSON — for CI/CD integration +npx ecc-agentshield scan --format json + +# Markdown — for documentation +npx ecc-agentshield scan --format markdown + +# HTML — self-contained dark-theme report +npx ecc-agentshield scan --format html > security-report.html +``` + +### 自动修复 + +自动应用安全的修复（仅修复标记为可自动修复的问题）： + +```bash +npx ecc-agentshield scan --fix +``` + +这将： + +* 用环境变量引用替换硬编码的密钥 +* 将通配符权限收紧为作用域明确的替代方案 +* 绝不修改仅限手动修复的建议 + +### Opus 4.6 深度分析 + +运行对抗性的三智能体流程以进行更深入的分析： + +```bash +# Requires ANTHROPIC_API_KEY +export ANTHROPIC_API_KEY=your-key +npx ecc-agentshield scan --opus --stream +``` + +这将运行： + +1. **攻击者（红队）** — 寻找攻击向量 +2. **防御者（蓝队）** — 建议加固措施 +3. **审计员（最终裁决）** — 综合双方观点 + +### 初始化安全配置 + +从头开始搭建一个新的安全 `.claude/` 配置： + +```bash +npx ecc-agentshield init +``` + +创建： + +* 具有作用域权限和拒绝列表的 `settings.json` +* 遵循安全最佳实践的 `CLAUDE.md` +* `mcp.json` 占位符 + +### GitHub Action + +添加到您的 CI 流水线中： + +```yaml +- uses: affaan-m/agentshield@v1 + with: + path: '.' + min-severity: 'medium' + fail-on-findings: true +``` + +## 严重性等级 + +| 等级 | 分数 | 含义 | +|-------|-------|---------| +| A | 90-100 | 安全配置 | +| B | 75-89 | 轻微问题 | +| C | 60-74 | 需要注意 | +| D | 40-59 | 显著风险 | +| F | 0-39 | 严重漏洞 | + +## 结果解读 + +### 关键发现（立即修复） + +* 配置文件中硬编码的 API 密钥或令牌 +* 允许列表中存在 `Bash(*)`（无限制的 shell 访问） +* 钩子中通过 `${file}` 插值导致的命令注入 +* 运行 shell 的 MCP 服务器 + +### 高优先级发现（生产前修复） + +* CLAUDE.md 中的自动运行指令（提示词注入向量） +* 权限配置中缺少拒绝列表 +* 具有不必要 Bash 访问权限的代理 + +### 中优先级发现（建议修复） + +* 钩子中的静默错误抑制（`2>/dev/null`、`|| true`） +* 缺少 PreToolUse 安全钩子 +* MCP 服务器配置中的 `npx -y` 自动安装 + +### 信息性发现（了解情况） + +* MCP 服务器缺少描述信息 +* 正确标记为良好实践的限制性指令 + +## 链接 + +* **GitHub**: [github.com/affaan-m/agentshield](https://github.com/affaan-m/agentshield) +* **npm**: [npmjs.com/package/ecc-agentshield](https://www.npmjs.com/package/ecc-agentshield) diff --git a/docs/zh-CN/the-longform-guide.md b/docs/zh-CN/the-longform-guide.md new file mode 100644 index 0000000..13c81b5 --- /dev/null +++ b/docs/zh-CN/the-longform-guide.md @@ -0,0 +1,358 @@ +# 关于 Claude Code 的完整长篇指南 + +![Header: The Longform Guide to Everything Claude Code](../../assets/images/longform/01-header.png) + +*** + +> **前提**：本指南建立在 [关于 Claude Code 的简明指南](./the-shortform-guide.md) 之上。如果你还没有设置技能、钩子、子代理、MCP 和插件，请先阅读该指南。 + +![Reference to Shorthand Guide](../../assets/images/longform/02-shortform-reference.png) +*速记指南 - 请先阅读它* + +在简明指南中，我介绍了基础设置：技能和命令、钩子、子代理、MCP、插件，以及构成有效 Claude Code 工作流骨干的配置模式。那是设置指南和基础架构。 + +这篇长篇指南深入探讨了区分高效会话与浪费会话的技巧。如果你还没有阅读简明指南，请先返回并设置好你的配置。以下内容假定你已经配置好技能、代理、钩子和 MCP，并且它们正在工作。 + +这里的主题是：令牌经济、记忆持久性、验证模式、并行化策略，以及构建可重用工作流的复合效应。这些是我在超过 10 个月的日常使用中提炼出的模式，它们决定了你是在第一个小时内就饱受上下文腐化之苦，还是能够保持数小时的高效会话。 + +简明指南和长篇指南中涵盖的所有内容都可以在 GitHub 上找到：`github.com/affaan-m/everything-claude-code` + +*** + +## 技巧与窍门 + +### 有些 MCP 是可替换的，可以释放你的上下文窗口 + +对于诸如版本控制（GitHub）、数据库（Supabase）、部署（Vercel、Railway）等 MCP 来说——这些平台大多已经拥有健壮的 CLI，MCP 本质上只是对其进行包装。MCP 是一个很好的包装器，但它是有代价的。 + +要让 CLI 功能更像 MCP，而不实际使用 MCP（以及随之而来的减少的上下文窗口），可以考虑将功能打包成技能和命令。提取出 MCP 暴露的、使事情变得容易的工具，并将它们转化为命令。 + +示例：与其始终加载 GitHub MCP，不如创建一个包装了 `gh pr create` 并带有你偏好选项的 `/gh-pr` 命令。与其让 Supabase MCP 消耗上下文，不如创建直接使用 Supabase CLI 的技能。 + +有了延迟加载，上下文窗口问题基本解决了。但令牌使用和成本问题并未以同样的方式解决。CLI + 技能的方法仍然是一种令牌优化方法。 + +*** + +## 重要事项 + +### 上下文与记忆管理 + +要在会话间共享记忆，最好的方法是使用一个技能或命令来总结和检查进度，然后保存到 `.claude` 文件夹中的一个 `.tmp` 文件中，并在会话结束前不断追加内容。第二天，它可以将其用作上下文，并从中断处继续。为每个会话创建一个新文件，这样你就不会将旧的上下文污染到新的工作中。 + +![Session Storage File Tree](../../assets/images/longform/03-session-storage.png) +*会话存储示例 -> https://github.com/affaan-m/everything-claude-code/tree/main/examples/sessions* + +Claude 创建一个总结当前状态的文件。审阅它，如果需要则要求编辑，然后重新开始。对于新的对话，只需提供文件路径。当你达到上下文限制并需要继续复杂工作时，这尤其有用。这些文件应包含： + +* 哪些方法有效（有证据可验证） +* 哪些方法尝试过但无效 +* 哪些方法尚未尝试，以及剩下什么需要做 + +**策略性地清除上下文：** + +一旦你制定了计划并清除了上下文（Claude Code 中计划模式的默认选项），你就可以根据计划工作。当你积累了大量与执行不再相关的探索性上下文时，这很有用。对于策略性压缩，请禁用自动压缩。在逻辑间隔手动压缩，或创建一个为你执行此操作的技能。 + +**高级：动态系统提示注入** + +我学到的一个模式是：与其将所有内容都放在 CLAUDE.md（用户作用域）或 `.claude/rules/`（项目作用域）中，让它们每次会话都加载，不如使用 CLI 标志动态注入上下文。 + +```bash +claude --system-prompt "$(cat memory.md)" +``` + +这让你可以更精确地控制何时加载哪些上下文。系统提示内容比用户消息具有更高的权威性，而用户消息又比工具结果具有更高的权威性。 + +**实际设置：** + +```bash +# Daily development +alias claude-dev='claude --system-prompt "$(cat ~/.claude/contexts/dev.md)"' + +# PR review mode +alias claude-review='claude --system-prompt "$(cat ~/.claude/contexts/review.md)"' + +# Research/exploration mode +alias claude-research='claude --system-prompt "$(cat ~/.claude/contexts/research.md)"' +``` + +**高级：记忆持久化钩子** + +有一些大多数人不知道的钩子，有助于记忆管理： + +* **PreCompact 钩子**：在上下文压缩发生之前，将重要状态保存到文件 +* **Stop 钩子（会话结束）**：在会话结束时，将学习成果持久化到文件 +* **SessionStart 钩子**：在新会话开始时，自动加载之前的上下文 + +我已经构建了这些钩子，它们位于仓库的 `github.com/affaan-m/everything-claude-code/tree/main/hooks/memory-persistence` + +*** + +### 持续学习 / 记忆 + +如果你不得不多次重复一个提示，并且 Claude 遇到了同样的问题或给出了你以前听过的回答——这些模式必须被附加到技能中。 + +**问题：** 浪费令牌，浪费上下文，浪费时间。 + +**解决方案：** 当 Claude Code 发现一些不平凡的事情时——调试技巧、变通方法、某些项目特定的模式——它会将该知识保存为一个新技能。下次出现类似问题时，该技能会自动加载。 + +我构建了一个实现此功能的持续学习技能：`github.com/affaan-m/everything-claude-code/tree/main/skills/continuous-learning` + +**为什么用 Stop 钩子（而不是 UserPromptSubmit）：** + +关键的设计决策是使用 **Stop 钩子** 而不是 UserPromptSubmit。UserPromptSubmit 在每个消息上运行——给每个提示增加延迟。Stop 在会话结束时只运行一次——轻量级，不会在会话期间拖慢你的速度。 + +*** + +### 令牌优化 + +**主要策略：子代理架构** + +优化你使用的工具和子代理架构，旨在将任务委托给最便宜且足以胜任的模型。 + +**模型选择快速参考：** + +![Model Selection Table](../../assets/images/longform/04-model-selection.png) +*针对各种常见任务的子代理假设设置及选择背后的理由* + +| 任务类型 | 模型 | 原因 | +| ------------------------- | ------ | ------------------------------------------ | +| 探索/搜索 | Haiku | 快速、便宜，足以用于查找文件 | +| 简单编辑 | Haiku | 单文件更改，指令清晰 | +| 多文件实现 | Sonnet | 编码的最佳平衡 | +| 复杂架构 | Opus | 需要深度推理 | +| PR 审查 | Sonnet | 理解上下文，捕捉细微差别 | +| 安全分析 | Opus | 不能错过漏洞 | +| 编写文档 | Haiku | 结构简单 | +| 调试复杂错误 | Opus | 需要将整个系统记在脑中 | + +对于 90% 的编码任务，默认使用 Sonnet。当第一次尝试失败、任务涉及 5 个以上文件、架构决策或安全关键代码时，升级到 Opus。 + +**定价参考：** + +![Claude Model Pricing](../../assets/images/longform/05-pricing-table.png) +*来源：https://platform.claude.com/docs/en/about-claude/pricing* + +**工具特定优化：** + +用 mgrep 替换 grep——与传统 grep 或 ripgrep 相比，平均减少约 50% 的令牌： + +![mgrep Benchmark](../../assets/images/longform/06-mgrep-benchmark.png) +*在我们的 50 项任务基准测试中，mgrep + Claude Code 使用了比基于 grep 的工作流少约 2 倍的 token，且判断质量相似或更好。来源：https://github.com/mixedbread-ai/mgrep* + +**模块化代码库的好处：** + +拥有一个更模块化的代码库，主文件只有数百行而不是数千行，这有助于降低令牌优化成本，并确保任务在第一次尝试时就正确完成。 + +*** + +### 验证循环与评估 + +**基准测试工作流：** + +比较在有和没有技能的情况下询问同一件事，并检查输出差异： + +分叉对话，在其中之一的对话中初始化一个新的工作树但不使用该技能，最后拉取差异，查看记录了什么。 + +**评估模式类型：** + +* **基于检查点的评估**：设置明确的检查点，根据定义的标准进行验证，在继续之前修复 +* **持续评估**：每 N 分钟或在重大更改后运行，完整的测试套件 + 代码检查 + +**关键指标：** + +``` +pass@k: At least ONE of k attempts succeeds + k=1: 70% k=3: 91% k=5: 97% + +pass^k: ALL k attempts must succeed + k=1: 70% k=3: 34% k=5: 17% +``` + +当你只需要它能工作时，使用 **pass@k**。当一致性至关重要时，使用 **pass^k**。 + +*** + +## 并行化 + +在多 Claude 终端设置中分叉对话时，请确保分叉中的操作和原始对话的范围定义明确。在代码更改方面，力求最小化重叠。 + +**我偏好的模式：** + +主聊天用于代码更改，分叉用于询问有关代码库及其当前状态的问题，或研究外部服务。 + +**关于任意终端数量：** + +![Boris on Parallel Terminals](../../assets/images/longform/07-boris-parallel.png) +*Boris (Anthropic) 关于运行多个 Claude 实例的说明* + +Boris 有关于并行化的建议。他曾建议在本地运行 5 个 Claude 实例，在上游运行 5 个。我建议不要设置任意的终端数量。增加终端应该是出于真正的必要性。 + +你的目标应该是：**用最小可行的并行化程度，你能完成多少工作。** + +**用于并行实例的 Git Worktrees：** + +```bash +# Create worktrees for parallel work +git worktree add ../project-feature-a feature-a +git worktree add ../project-feature-b feature-b +git worktree add ../project-refactor refactor-branch + +# Each worktree gets its own Claude instance +cd ../project-feature-a && claude +``` + +**如果** 你要开始扩展实例数量 **并且** 你有多个 Claude 实例在处理相互重叠的代码，那么你必须使用 git worktrees，并为每个实例制定非常明确的计划。使用 `/rename ` 来命名你所有的聊天。 + +![Two Terminal Setup](../../assets/images/longform/08-two-terminals.png) +*初始设置：左终端用于编码，右终端用于提问 - 使用 /rename 和 /fork* + +**级联方法：** + +当运行多个 Claude Code 实例时，使用“级联”模式进行组织： + +* 在右侧的新标签页中打开新任务 +* 从左到右、从旧到新进行扫描 +* 一次最多专注于 3-4 个任务 + +*** + +## 基础工作 + +**双实例启动模式：** + +对于我自己的工作流管理，我喜欢从一个空仓库开始，打开 2 个 Claude 实例。 + +**实例 1：脚手架代理** + +* 搭建脚手架和基础工作 +* 创建项目结构 +* 设置配置（CLAUDE.md、规则、代理） + +**实例 2：深度研究代理** + +* 连接到你的所有服务，进行网络搜索 +* 创建详细的 PRD +* 创建架构 Mermaid 图 +* 编译包含实际文档片段的参考资料 + +**llms.txt 模式：** + +如果可用，你可以通过在你到达它们的文档页面后执行 `/llms.txt` 来在许多文档参考资料上找到一个 `llms.txt`。这会给你一个干净的、针对 LLM 优化的文档版本。 + +**理念：构建可重用的模式** + +来自 @omarsar0："早期，我花时间构建可重用的工作流/模式。构建过程很繁琐，但随着模型和代理框架的改进，这产生了惊人的复合效应。" + +**应该投资于：** + +* 子代理 +* 技能 +* 命令 +* 规划模式 +* MCP 工具 +* 上下文工程模式 + +*** + +## 代理与子代理的最佳实践 + +**子代理上下文问题：** + +子代理的存在是为了通过返回摘要而不是转储所有内容来节省上下文。但编排器拥有子代理所缺乏的语义上下文。子代理只知道字面查询，不知道请求背后的 **目的**。 + +**迭代检索模式：** + +1. 编排器评估每个子代理的返回 +2. 在接受之前询问后续问题 +3. 子代理返回源，获取答案，返回 +4. 循环直到足够（最多 3 个周期） + +**关键：** 传递目标上下文，而不仅仅是查询。 + +**具有顺序阶段的编排器：** + +```markdown +第一阶段：研究（使用探索智能体）→ research-summary.md +第二阶段：规划（使用规划智能体）→ plan.md +第三阶段：实施（使用测试驱动开发指南智能体）→ 代码变更 +第四阶段：审查（使用代码审查智能体）→ review-comments.md +第五阶段：验证（如需则使用构建错误解决器）→ 完成或循环返回 + +``` + +**关键规则：** + +1. 每个智能体获得一个清晰的输入并产生一个清晰的输出 +2. 输出成为下一阶段的输入 +3. 永远不要跳过阶段 +4. 在智能体之间使用 `/clear` +5. 将中间输出存储在文件中 + +*** + +## 有趣的东西 / 非关键，仅供娱乐的小贴士 + +### 自定义状态栏 + +你可以使用 `/statusline` 来设置它 - 然后 Claude 会说你没有状态栏，但可以为你设置，并询问你想要在里面放什么。 + +另请参阅：https://github.com/sirmalloc/ccstatusline + +### 语音转录 + +用你的声音与 Claude Code 对话。对很多人来说比打字更快。 + +* Mac 上的 superwhisper、MacWhisper +* 即使转录有误，Claude 也能理解意图 + +### 终端别名 + +```bash +alias c='claude' +alias gb='github' +alias co='code' +alias q='cd ~/Desktop/projects' +``` + +*** + +## 里程碑 + +![25k+ GitHub Stars](../../assets/images/longform/09-25k-stars.png) +*一周内获得 25,000+ GitHub stars* + +*** + +## 资源 + +**智能体编排：** + +* https://github.com/ruvnet/claude-flow - 拥有 54+ 个专业智能体的企业级编排平台 + +**自我改进记忆：** + +* https://github.com/affaan-m/everything-claude-code/tree/main/skills/continuous-learning +* rlancemartin.github.io/2025/12/01/claude\_diary/ - 会话反思模式 + +**系统提示词参考：** + +* https://github.com/x1xhlol/system-prompts-and-models-of-ai-tools - 系统提示词集合 (110k stars) + +**官方：** + +* Anthropic Academy: anthropic.skilljar.com + +*** + +## 参考资料 + +* [Anthropic: 解密 AI 智能体的评估](https://www.anthropic.com/engineering/demystifying-evals-for-ai-agents) +* [YK: 32 个 Claude Code 技巧](https://agenticcoding.substack.com/p/32-claude-code-tips-from-basics-to) +* [RLanceMartin: 会话反思模式](https://rlancemartin.github.io/2025/12/01/claude_diary/) +* @PerceptualPeak: 子智能体上下文协商 +* @menhguin: 智能体抽象层分级 +* @omarsar0: 复合效应哲学 + +*** + +*两份指南中涵盖的所有内容都可以在 GitHub 上的 [everything-claude-code](https://github.com/affaan-m/everything-claude-code) 找到* diff --git a/docs/zh-CN/the-shortform-guide.md b/docs/zh-CN/the-shortform-guide.md new file mode 100644 index 0000000..6ea75a5 --- /dev/null +++ b/docs/zh-CN/the-shortform-guide.md @@ -0,0 +1,431 @@ +# Claude Code 简明指南 + +![Header: Anthropic Hackathon Winner - Tips & Tricks for Claude Code](../../assets/images/shortform/00-header.png) + +*** + +**自 2 月实验性推出以来，我一直是 Claude Code 的忠实用户，并凭借 [zenith.chat](https://zenith.chat) 与 [@DRodriguezFX](https://x.com/DRodriguezFX) 一起赢得了 Anthropic x Forum Ventures 的黑客马拉松——完全使用 Claude Code。** + +经过 10 个月的日常使用，以下是我的完整设置：技能、钩子、子代理、MCP、插件以及实际有效的方法。 + +*** + +## 技能和命令 + +技能就像规则，受限于特定的范围和流程。当你需要执行特定工作流时，它们是提示词的简写。 + +在使用 Opus 4.5 长时间编码后，你想清理死代码和松散的 .md 文件吗？运行 `/refactor-clean`。需要测试吗？`/tdd`、`/e2e`、`/test-coverage`。技能也可以包含代码地图——一种让 Claude 快速浏览你的代码库而无需消耗上下文进行探索的方式。 + +![显示链式命令的终端](../../assets/images/shortform/02-chaining-commands.jpeg) +*将命令链接在一起* + +命令是通过斜杠命令执行的技能。它们有重叠但存储方式不同： + +* **技能**: `~/.claude/skills/` - 更广泛的工作流定义 +* **命令**: `~/.claude/commands/` - 快速可执行的提示词 + +```bash +# Example skill structure +~/.claude/skills/ + pmx-guidelines.md # Project-specific patterns + coding-standards.md # Language best practices + tdd-workflow/ # Multi-file skill with README.md + security-review/ # Checklist-based skill +``` + +*** + +## 钩子 + +钩子是基于触发的自动化，在特定事件发生时触发。与技能不同，它们受限于工具调用和生命周期事件。 + +**钩子类型：** + +1. **PreToolUse** - 工具执行前（验证、提醒） +2. **PostToolUse** - 工具完成后（格式化、反馈循环） +3. **UserPromptSubmit** - 当你发送消息时 +4. **Stop** - 当 Claude 完成响应时 +5. **PreCompact** - 上下文压缩前 +6. **Notification** - 权限请求 + +**示例：长时间运行命令前的 tmux 提醒** + +```json +{ + "PreToolUse": [ + { + "matcher": "tool == \"Bash\" && tool_input.command matches \"(npm|pnpm|yarn|cargo|pytest)\"", + "hooks": [ + { + "type": "command", + "command": "if [ -z \"$TMUX\" ]; then echo '[Hook] Consider tmux for session persistence' >&2; fi" + } + ] + } + ] +} +``` + +![PostToolUse 钩子反馈](../../assets/images/shortform/03-posttooluse-hook.png) +*在 Claude Code 中运行 PostToolUse 钩子时获得的反馈示例* + +**专业提示：** 使用 `hookify` 插件以对话方式创建钩子，而不是手动编写 JSON。运行 `/hookify` 并描述你想要什么。 + +*** + +## 子代理 + +子代理是你的编排器（主 Claude）可以委托任务给它的、具有有限范围的进程。它们可以在后台或前台运行，为主代理释放上下文。 + +子代理与技能配合得很好——一个能够执行你技能子集的子代理可以被委托任务并自主使用这些技能。它们也可以用特定的工具权限进行沙盒化。 + +```bash +# Example subagent structure +~/.claude/agents/ + planner.md # Feature implementation planning + architect.md # System design decisions + tdd-guide.md # Test-driven development + code-reviewer.md # Quality/security review + security-reviewer.md # Vulnerability analysis + build-error-resolver.md + e2e-runner.md + refactor-cleaner.md +``` + +为每个子代理配置允许的工具、MCP 和权限，以实现适当的范围界定。 + +*** + +## 规则和记忆 + +你的 `.rules` 文件夹包含 `.md` 文件，其中是 Claude 应始终遵循的最佳实践。有两种方法： + +1. **单一 CLAUDE.md** - 所有内容在一个文件中（用户或项目级别） +2. **规则文件夹** - 按关注点分组的模块化 `.md` 文件 + +```bash +~/.claude/rules/ + security.md # No hardcoded secrets, validate inputs + coding-style.md # Immutability, file organization + testing.md # TDD workflow, 80% coverage + git-workflow.md # Commit format, PR process + agents.md # When to delegate to subagents + performance.md # Model selection, context management +``` + +**规则示例：** + +* 代码库中不使用表情符号 +* 前端避免使用紫色色调 +* 部署前始终测试代码 +* 优先考虑模块化代码而非巨型文件 +* 绝不提交 console.log + +*** + +## MCP（模型上下文协议） + +MCP 将 Claude 直接连接到外部服务。它不是 API 的替代品——而是围绕 API 的提示驱动包装器，允许在导航信息时具有更大的灵活性。 + +**示例：** Supabase MCP 允许 Claude 提取特定数据，直接在上游运行 SQL 而无需复制粘贴。数据库、部署平台等也是如此。 + +![Supabase MCP 列出表格](../../assets/images/shortform/04-supabase-mcp.jpeg) +*Supabase MCP 列出公共模式内表格的示例* + +**Claude 中的 Chrome：** 是一个内置的插件 MCP，允许 Claude 自主控制你的浏览器——点击查看事物如何工作。 + +**关键：上下文窗口管理** + +对 MCP 要挑剔。我将所有 MCP 保存在用户配置中，但**禁用所有未使用的**。导航到 `/plugins` 并向下滚动，或运行 `/mcp`。 + +![/plugins 界面](../../assets/images/shortform/05-plugins-interface.jpeg) +*使用 /plugins 导航到 MCP 以查看当前安装的插件及其状态* + +在压缩之前，你的 200k 上下文窗口如果启用了太多工具，可能只有 70k。性能会显著下降。 + +**经验法则：** 在配置中保留 20-30 个 MCP，但保持启用状态少于 10 个 / 活动工具少于 80 个。 + +```bash +# Check enabled MCPs +/mcp + +# Disable unused ones in ~/.claude.json under projects.disabledMcpServers +``` + +*** + +## 插件 + +插件将工具打包以便于安装，而不是繁琐的手动设置。一个插件可以是技能和 MCP 的组合，或者是捆绑在一起的钩子/工具。 + +**安装插件：** + +```bash +# Add a marketplace +claude plugin marketplace add https://github.com/mixedbread-ai/mgrep + +# Open Claude, run /plugins, find new marketplace, install from there +``` + +![显示 mgrep 的市场标签页](../../assets/images/shortform/06-marketplaces-mgrep.jpeg) +*显示新安装的 Mixedbread-Grep 市场* + +**LSP 插件** 如果你经常在编辑器之外运行 Claude Code，则特别有用。语言服务器协议为 Claude 提供实时类型检查、跳转到定义和智能补全，而无需打开 IDE。 + +```bash +# Enabled plugins example +typescript-lsp@claude-plugins-official # TypeScript intelligence +pyright-lsp@claude-plugins-official # Python type checking +hookify@claude-plugins-official # Create hooks conversationally +mgrep@Mixedbread-Grep # Better search than ripgrep +``` + +与 MCP 相同的警告——注意你的上下文窗口。 + +*** + +## 技巧和窍门 + +### 键盘快捷键 + +* `Ctrl+U` - 删除整行（比反复按退格键快） +* `!` - 快速 bash 命令前缀 +* `@` - 搜索文件 +* `/` - 发起斜杠命令 +* `Shift+Enter` - 多行输入 +* `Tab` - 切换思考显示 +* `Esc Esc` - 中断 Claude / 恢复代码 + +### 并行工作流 + +* **分叉** (`/fork`) - 分叉对话以并行执行不重叠的任务，而不是在队列中堆积消息 +* **Git Worktrees** - 用于重叠的并行 Claude 而不产生冲突。每个工作树都是一个独立的检出 + +```bash +git worktree add ../feature-branch feature-branch +# Now run separate Claude instances in each worktree +``` + +### 用于长时间运行命令的 tmux + +流式传输和监视 Claude 运行的日志/bash 进程： + +https://github.com/user-attachments/assets/shortform/07-tmux-video.mp4 + +```bash +tmux new -s dev +# Claude runs commands here, you can detach and reattach +tmux attach -t dev +``` + +### mgrep > grep + +`mgrep` 是对 ripgrep/grep 的显著改进。通过插件市场安装，然后使用 `/mgrep` 技能。适用于本地搜索和网络搜索。 + +```bash +mgrep "function handleSubmit" # Local search +mgrep --web "Next.js 15 app router changes" # Web search +``` + +### 其他有用的命令 + +* `/rewind` - 回到之前的状态 +* `/statusline` - 用分支、上下文百分比、待办事项进行自定义 +* `/checkpoints` - 文件级别的撤销点 +* `/compact` - 手动触发上下文压缩 + +### GitHub Actions CI/CD + +使用 GitHub Actions 在你的 PR 上设置代码审查。配置后，Claude 可以自动审查 PR。 + +![Claude 机器人批准 PR](../../assets/images/shortform/08-github-pr-review.jpeg) +*Claude 批准一个错误修复 PR* + +### 沙盒化 + +对风险操作使用沙盒模式——Claude 在受限环境中运行，不影响你的实际系统。 + +*** + +## 关于编辑器 + +你的编辑器选择显著影响 Claude Code 的工作流。虽然 Claude Code 可以在任何终端中工作，但将其与功能强大的编辑器配对可以解锁实时文件跟踪、快速导航和集成命令执行。 + +### Zed（我的偏好） + +我使用 [Zed](https://zed.dev) —— 用 Rust 编写，所以它真的很快。立即打开，轻松处理大型代码库，几乎不占用系统资源。 + +**为什么 Zed + Claude Code 是绝佳组合：** + +* **速度** - 基于 Rust 的性能意味着当 Claude 快速编辑文件时没有延迟。你的编辑器能跟上 +* **代理面板集成** - Zed 的 Claude 集成允许你在 Claude 编辑时实时跟踪文件变化。无需离开编辑器即可跳转到 Claude 引用的文件 +* **CMD+Shift+R 命令面板** - 快速访问所有自定义斜杠命令、调试器、构建脚本，在可搜索的 UI 中 +* **最小的资源使用** - 在繁重操作期间不会与 Claude 竞争 RAM/CPU。运行 Opus 时很重要 +* **Vim 模式** - 完整的 vim 键绑定，如果你喜欢的话 + +![带有自定义命令的 Zed 编辑器](../../assets/images/shortform/09-zed-editor.jpeg) +*使用 CMD+Shift+R 显示自定义命令下拉菜单的 Zed 编辑器。右下角的靶心图标表示跟随模式。* + +**编辑器无关提示：** + +1. **分割你的屏幕** - 一侧是带 Claude Code 的终端，另一侧是编辑器 +2. **Ctrl + G** - 在 Zed 中快速打开 Claude 当前正在处理的文件 +3. **自动保存** - 启用自动保存，以便 Claude 的文件读取始终是最新的 +4. **Git 集成** - 使用编辑器的 git 功能在提交前审查 Claude 的更改 +5. **文件监视器** - 大多数编辑器自动重新加载更改的文件，请验证是否已启用 + +### VSCode / Cursor + +这也是一个可行的选择，并且与 Claude Code 配合良好。你可以使用终端格式，通过 `\ide` 与你的编辑器自动同步以启用 LSP 功能（现在与插件有些冗余）。或者你可以选择扩展，它更集成于编辑器并具有匹配的 UI。 + +![VS Code Claude Code 扩展](../../assets/images/shortform/10-vscode-extension.jpeg) +*VS Code 扩展为 Claude Code 提供了原生图形界面，直接集成到您的 IDE 中。* + +*** + +## 我的设置 + +### 插件 + +**已安装：**（我通常一次只启用其中的 4-5 个） + +```markdown +ralph-wiggum@claude-code-plugins # 循环自动化 +frontend-design@claude-code-plugins # UI/UX 模式 +commit-commands@claude-code-plugins # Git 工作流 +security-guidance@claude-code-plugins # 安全检查 +pr-review-toolkit@claude-code-plugins # PR 自动化 +typescript-lsp@claude-plugins-official # TS 智能 +hookify@claude-plugins-official # Hook 创建 +code-simplifier@claude-plugins-official +feature-dev@claude-code-plugins +explanatory-output-style@claude-code-plugins +code-review@claude-code-plugins +context7@claude-plugins-official # 实时文档 +pyright-lsp@claude-plugins-official # Python 类型 +mgrep@Mixedbread-Grep # 更好的搜索 + +``` + +### MCP 服务器 + +**已配置（用户级别）：** + +```json +{ + "github": { "command": "npx", "args": ["-y", "@modelcontextprotocol/server-github"] }, + "firecrawl": { "command": "npx", "args": ["-y", "firecrawl-mcp"] }, + "supabase": { + "command": "npx", + "args": ["-y", "@supabase/mcp-server-supabase@latest", "--project-ref=YOUR_REF"] + }, + "memory": { "command": "npx", "args": ["-y", "@modelcontextprotocol/server-memory"] }, + "sequential-thinking": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-sequential-thinking"] + }, + "vercel": { "type": "http", "url": "https://mcp.vercel.com" }, + "railway": { "command": "npx", "args": ["-y", "@railway/mcp-server"] }, + "cloudflare-docs": { "type": "http", "url": "https://docs.mcp.cloudflare.com/mcp" }, + "cloudflare-workers-bindings": { + "type": "http", + "url": "https://bindings.mcp.cloudflare.com/mcp" + }, + "clickhouse": { "type": "http", "url": "https://mcp.clickhouse.cloud/mcp" }, + "AbletonMCP": { "command": "uvx", "args": ["ableton-mcp"] }, + "magic": { "command": "npx", "args": ["-y", "@magicuidesign/mcp@latest"] } +} +``` + +这是关键——我配置了 14 个 MCP，但每个项目只启用约 5-6 个。保持上下文窗口健康。 + +### 关键钩子 + +```json +{ + "PreToolUse": [ + { "matcher": "npm|pnpm|yarn|cargo|pytest", "hooks": ["tmux reminder"] }, + { "matcher": "Write && .md file", "hooks": ["block unless README/CLAUDE"] }, + { "matcher": "git push", "hooks": ["open editor for review"] } + ], + "PostToolUse": [ + { "matcher": "Edit && .ts/.tsx/.js/.jsx", "hooks": ["prettier --write"] }, + { "matcher": "Edit && .ts/.tsx", "hooks": ["tsc --noEmit"] }, + { "matcher": "Edit", "hooks": ["grep console.log warning"] } + ], + "Stop": [ + { "matcher": "*", "hooks": ["check modified files for console.log"] } + ] +} +``` + +### 自定义状态行 + +显示用户、目录、带脏标记的 git 分支、剩余上下文百分比、模型、时间和待办事项计数： + +![自定义状态行](../../assets/images/shortform/11-statusline.jpeg) +*我的 Mac 根目录中的状态行示例* + +``` +affoon:~ ctx:65% Opus 4.5 19:52 +▌▌ plan mode on (shift+tab to cycle) +``` + +### 规则结构 + +``` +~/.claude/rules/ + security.md # Mandatory security checks + coding-style.md # Immutability, file size limits + testing.md # TDD, 80% coverage + git-workflow.md # Conventional commits + agents.md # Subagent delegation rules + patterns.md # API response formats + performance.md # Model selection (Haiku vs Sonnet vs Opus) + hooks.md # Hook documentation +``` + +### 子代理 + +``` +~/.claude/agents/ + planner.md # Break down features + architect.md # System design + tdd-guide.md # Write tests first + code-reviewer.md # Quality review + security-reviewer.md # Vulnerability scan + build-error-resolver.md + e2e-runner.md # Playwright tests + refactor-cleaner.md # Dead code removal + doc-updater.md # Keep docs synced +``` + +*** + +## 关键要点 + +1. **不要过度复杂化** - 将配置视为微调，而非架构 +2. **上下文窗口很宝贵** - 禁用未使用的 MCP 和插件 +3. **并行执行** - 分叉对话，使用 git worktrees +4. **自动化重复性工作** - 用于格式化、代码检查、提醒的钩子 +5. **界定子代理范围** - 有限的工具 = 专注的执行 + +*** + +## 参考资料 + +* [插件参考](https://code.claude.com/docs/en/plugins-reference) +* [钩子文档](https://code.claude.com/docs/en/hooks) +* [检查点](https://code.claude.com/docs/en/checkpointing) +* [交互模式](https://code.claude.com/docs/en/interactive-mode) +* [记忆系统](https://code.claude.com/docs/en/memory) +* [子代理](https://code.claude.com/docs/en/sub-agents) +* [MCP 概述](https://code.claude.com/docs/en/mcp-overview) + +*** + +**注意：** 这是细节的一个子集。关于高级模式，请参阅 [长篇指南](./the-longform-guide.md)。 + +*** + +*在纽约与 [@DRodriguezFX](https://x.com/DRodriguezFX) 一起构建 [zenith.chat](https://zenith.chat) 赢得了 Anthropic x Forum Ventures 黑客马拉松*