mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-02-19 04:33:11 +08:00
* docs: add Chinese versions docs * update --------- Co-authored-by: neo <neo.dowithless@gmail.com>
559 lines
18 KiB
Markdown
559 lines
18 KiB
Markdown
**语言:** English | [繁體中文](docs/zh-TW/README.md) | [简体中文](docs/zh-CN/README.md)
|
||
|
||
# Everything Claude Code
|
||
|
||
[](https://github.com/affaan-m/everything-claude-code/stargazers)
|
||
[](LICENSE)
|
||

|
||

|
||

|
||

|
||
|
||
***
|
||
|
||
<div align="center">
|
||
|
||
**🌐 语言 / 语言 / 語言**
|
||
|
||
[**English**](README.md) | [简体中文](README.zh-CN.md) | [繁體中文](docs/zh-TW/README.md)
|
||
|
||
</div>
|
||
|
||
***
|
||
|
||
**Anthropic 黑客马拉松获胜者提供的完整 Claude Code 配置集合。**
|
||
|
||
经过 10 多个月的密集日常使用,在构建真实产品的过程中演化出的生产就绪的智能体、技能、钩子、命令、规则和 MCP 配置。
|
||
|
||
***
|
||
|
||
## 指南
|
||
|
||
此仓库仅包含原始代码。指南解释了一切。
|
||
|
||
<table>
|
||
<tr>
|
||
<td width="50%">
|
||
<a href="https://x.com/affaanmustafa/status/2012378465664745795">
|
||
<img src="https://github.com/user-attachments/assets/1a471488-59cc-425b-8345-5245c7efbcef" alt="The Shorthand Guide to Everything Claude Code" />
|
||
</a>
|
||
</td>
|
||
<td width="50%">
|
||
<a href="https://x.com/affaanmustafa/status/2014040193557471352">
|
||
<img src="https://github.com/user-attachments/assets/c9ca43bc-b149-427f-b551-af6840c368f0" alt="The Longform Guide to Everything Claude Code" />
|
||
</a>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td align="center"><b>Shorthand Guide</b><br/>Setup, foundations, philosophy. <b>Read this first.</b></td>
|
||
<td align="center"><b>Longform Guide</b><br/>Token optimization, memory persistence, evals, parallelization.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
| 主题 | 你将学到什么 |
|
||
|-------|-------------------|
|
||
| 令牌优化 | 模型选择,系统提示精简,后台进程 |
|
||
| 内存持久化 | 自动跨会话保存/加载上下文的钩子 |
|
||
| 持续学习 | 从会话中自动提取模式为可重用技能 |
|
||
| 验证循环 | 检查点与持续评估,评分器类型,pass@k 指标 |
|
||
| 并行化 | Git 工作树,级联方法,何时扩展实例 |
|
||
| 子智能体编排 | 上下文问题,迭代检索模式 |
|
||
|
||
***
|
||
|
||
## 🚀 快速开始
|
||
|
||
在 2 分钟内启动并运行:
|
||
|
||
### 步骤 1:安装插件
|
||
|
||
```bash
|
||
# Add marketplace
|
||
/plugin marketplace add affaan-m/everything-claude-code
|
||
|
||
# Install plugin
|
||
/plugin install everything-claude-code@everything-claude-code
|
||
```
|
||
|
||
### 步骤 2:安装规则(必需)
|
||
|
||
> ⚠️ **重要提示:** Claude Code 插件无法自动分发 `rules`。请手动安装它们:
|
||
|
||
```bash
|
||
# 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/
|
||
```
|
||
|
||
### 步骤 3:开始使用
|
||
|
||
```bash
|
||
# Try a command
|
||
/plan "Add user authentication"
|
||
|
||
# Check available commands
|
||
/plugin list everything-claude-code@everything-claude-code
|
||
```
|
||
|
||
✨ **就这样!** 您现在可以访问 15+ 个代理、30+ 个技能和 20+ 个命令。
|
||
|
||
***
|
||
|
||
## 🌐 跨平台支持
|
||
|
||
此插件现已完全支持 **Windows、macOS 和 Linux**。所有钩子和脚本都已用 Node.js 重写,以实现最大的兼容性。
|
||
|
||
### 包管理器检测
|
||
|
||
插件会自动检测您首选的包管理器(npm、pnpm、yarn 或 bun),优先级如下:
|
||
|
||
1. **环境变量**:`CLAUDE_PACKAGE_MANAGER`
|
||
2. **项目配置**:`.claude/package-manager.json`
|
||
3. **package.json**:`packageManager` 字段
|
||
4. **锁文件**:从 package-lock.json、yarn.lock、pnpm-lock.yaml 或 bun.lockb 检测
|
||
5. **全局配置**:`~/.claude/package-manager.json`
|
||
6. **回退方案**:第一个可用的包管理器
|
||
|
||
要设置您首选的包管理器:
|
||
|
||
```bash
|
||
# Via environment variable
|
||
export CLAUDE_PACKAGE_MANAGER=pnpm
|
||
|
||
# Via global config
|
||
node scripts/setup-package-manager.js --global pnpm
|
||
|
||
# Via project config
|
||
node scripts/setup-package-manager.js --project bun
|
||
|
||
# Detect current setting
|
||
node scripts/setup-package-manager.js --detect
|
||
```
|
||
|
||
或者在 Claude Code 中使用 `/setup-pm` 命令。
|
||
|
||
***
|
||
|
||
## 📦 包含内容
|
||
|
||
此仓库是一个 **Claude Code 插件** - 可以直接安装或手动复制组件。
|
||
|
||
```
|
||
everything-claude-code/
|
||
|-- .claude-plugin/ # 插件和插件市场清单
|
||
| |-- plugin.json # 插件元数据和组件路径
|
||
| |-- marketplace.json # 用于 /plugin marketplace add 的市场目录
|
||
|
|
||
|-- agents/ # 用于任务委派的专用子代理
|
||
| |-- planner.md # 功能实现规划
|
||
| |-- architect.md # 系统设计决策
|
||
| |-- tdd-guide.md # 测试驱动开发
|
||
| |-- code-reviewer.md # 质量与安全审查
|
||
| |-- security-reviewer.md # 漏洞分析
|
||
| |-- build-error-resolver.md
|
||
| |-- e2e-runner.md # Playwright 端到端测试
|
||
| |-- refactor-cleaner.md # 无用代码清理
|
||
| |-- doc-updater.md # 文档同步
|
||
| |-- go-reviewer.md # Go 代码审查(新增)
|
||
| |-- go-build-resolver.md # Go 构建错误修复(新增)
|
||
|
|
||
|-- skills/ # 工作流定义与领域知识
|
||
| |-- coding-standards/ # 各语言最佳实践
|
||
| |-- backend-patterns/ # API、数据库、缓存模式
|
||
| |-- frontend-patterns/ # React、Next.js 模式
|
||
| |-- continuous-learning/ # 从会话中自动提取模式(长文档指南)
|
||
| |-- continuous-learning-v2/ # 基于直觉的学习,带置信度评分
|
||
| |-- iterative-retrieval/ # 子代理的渐进式上下文精炼
|
||
| |-- strategic-compact/ # 手动压缩建议(长文档指南)
|
||
| |-- tdd-workflow/ # TDD 方法论
|
||
| |-- security-review/ # 安全检查清单
|
||
| |-- eval-harness/ # 验证循环评估(长文档指南)
|
||
| |-- verification-loop/ # 持续验证(长文档指南)
|
||
| |-- golang-patterns/ # Go 语言习惯用法与最佳实践(新增)
|
||
| |-- golang-testing/ # Go 测试模式、TDD、基准测试(新增)
|
||
|
|
||
|-- commands/ # 快捷执行的 Slash 命令
|
||
| |-- tdd.md # /tdd - 测试驱动开发
|
||
| |-- plan.md # /plan - 实现规划
|
||
| |-- e2e.md # /e2e - 端到端测试生成
|
||
| |-- code-review.md # /code-review - 质量审查
|
||
| |-- build-fix.md # /build-fix - 修复构建错误
|
||
| |-- refactor-clean.md # /refactor-clean - 清理无用代码
|
||
| |-- learn.md # /learn - 会话中提取模式(长文档指南)
|
||
| |-- checkpoint.md # /checkpoint - 保存验证状态(长文档指南)
|
||
| |-- verify.md # /verify - 运行验证循环(长文档指南)
|
||
| |-- setup-pm.md # /setup-pm - 配置包管理器
|
||
| |-- go-review.md # /go-review - Go 代码审查(新增)
|
||
| |-- go-test.md # /go-test - Go 的 TDD 工作流(新增)
|
||
| |-- go-build.md # /go-build - 修复 Go 构建错误(新增)
|
||
| |-- skill-create.md # /skill-create - 从 Git 历史生成技能(新增)
|
||
| |-- instinct-status.md # /instinct-status - 查看已学习的直觉(新增)
|
||
| |-- instinct-import.md # /instinct-import - 导入直觉(新增)
|
||
| |-- instinct-export.md # /instinct-export - 导出直觉(新增)
|
||
| |-- evolve.md # /evolve - 将直觉聚类为技能(新增)
|
||
|
|
||
|-- rules/ # 必须遵循的规则(复制到 ~/.claude/rules/)
|
||
| |-- security.md # 强制安全检查
|
||
| |-- coding-style.md # 不可变性、文件组织规范
|
||
| |-- testing.md # TDD,80% 覆盖率要求
|
||
| |-- git-workflow.md # 提交格式与 PR 流程
|
||
| |-- agents.md # 何时委派给子代理
|
||
| |-- performance.md # 模型选择与上下文管理
|
||
|
|
||
|-- hooks/ # 基于触发器的自动化
|
||
| |-- hooks.json # 所有 Hook 配置(PreToolUse、PostToolUse、Stop 等)
|
||
| |-- memory-persistence/ # 会话生命周期 Hook(长文档指南)
|
||
| |-- strategic-compact/ # 压缩建议(长文档指南)
|
||
|
|
||
|-- scripts/ # 跨平台 Node.js 脚本(新增)
|
||
| |-- lib/ # 共享工具
|
||
| | |-- utils.js # 跨平台文件 / 路径 / 系统工具
|
||
| | |-- package-manager.js # 包管理器检测与选择
|
||
| |-- hooks/ # Hook 实现
|
||
| | |-- session-start.js # 会话开始时加载上下文
|
||
| | |-- session-end.js # 会话结束时保存状态
|
||
| | |-- pre-compact.js # 压缩前状态保存
|
||
| | |-- suggest-compact.js # 战略性压缩建议
|
||
| | |-- evaluate-session.js # 从会话中提取模式
|
||
| |-- setup-package-manager.js # 交互式包管理器设置
|
||
|
|
||
|-- tests/ # 测试套件(新增)
|
||
| |-- lib/ # 库测试
|
||
| |-- hooks/ # Hook 测试
|
||
| |-- run-all.js # 运行所有测试
|
||
|
|
||
|-- contexts/ # 动态系统提示注入上下文(长文档指南)
|
||
| |-- dev.md # 开发模式上下文
|
||
| |-- review.md # 代码审查模式上下文
|
||
| |-- research.md # 研究 / 探索模式上下文
|
||
|
|
||
|-- examples/ # 示例配置与会话
|
||
| |-- CLAUDE.md # 项目级配置示例
|
||
| |-- user-CLAUDE.md # 用户级配置示例
|
||
|
|
||
|-- mcp-configs/ # MCP 服务器配置
|
||
| |-- mcp-servers.json # GitHub、Supabase、Vercel、Railway 等
|
||
|
|
||
|-- marketplace.json # 自托管插件市场配置(用于 /plugin marketplace add)
|
||
```
|
||
|
||
***
|
||
|
||
## 🛠️ 生态系统工具
|
||
|
||
### 技能创建器
|
||
|
||
从您的仓库生成 Claude Code 技能的两种方式:
|
||
|
||
#### 选项 A:本地分析(内置)
|
||
|
||
使用 `/skill-create` 命令进行本地分析,无需外部服务:
|
||
|
||
```bash
|
||
/skill-create # Analyze current repo
|
||
/skill-create --instincts # Also generate instincts for continuous-learning
|
||
```
|
||
|
||
这会在本地分析您的 git 历史记录并生成 SKILL.md 文件。
|
||
|
||
#### 选项 B:GitHub 应用(高级)
|
||
|
||
适用于高级功能(10k+ 提交、自动 PR、团队共享):
|
||
|
||
[安装 GitHub 应用](https://github.com/apps/skill-creator) | [ecc.tools](https://ecc.tools)
|
||
|
||
```bash
|
||
# Comment on any issue:
|
||
/skill-creator analyze
|
||
|
||
# Or auto-triggers on push to default branch
|
||
```
|
||
|
||
两种选项都会创建:
|
||
|
||
* **SKILL.md 文件** - 可供 Claude Code 使用的即用型技能
|
||
* **Instinct 集合** - 用于 continuous-learning-v2
|
||
* **模式提取** - 从您的提交历史中学习
|
||
|
||
### 🧠 持续学习 v2
|
||
|
||
基于本能的学习系统会自动学习您的模式:
|
||
|
||
```bash
|
||
/instinct-status # Show learned instincts with confidence
|
||
/instinct-import <file> # Import instincts from others
|
||
/instinct-export # Export your instincts for sharing
|
||
/evolve # Cluster related instincts into skills
|
||
```
|
||
|
||
完整文档请参阅 `skills/continuous-learning-v2/`。
|
||
|
||
***
|
||
|
||
## 📋 要求
|
||
|
||
### Claude Code CLI 版本
|
||
|
||
**最低版本:v2.1.0 或更高版本**
|
||
|
||
此插件需要 Claude Code CLI v2.1.0+,因为插件系统处理钩子的方式发生了变化。
|
||
|
||
检查您的版本:
|
||
|
||
```bash
|
||
claude --version
|
||
```
|
||
|
||
### 重要提示:钩子自动加载行为
|
||
|
||
> ⚠️ **对于贡献者:** 请勿向 `.claude-plugin/plugin.json` 添加 `"hooks"` 字段。这由回归测试强制执行。
|
||
|
||
Claude Code v2.1+ **会自动加载** 任何已安装插件中的 `hooks/hooks.json`(按约定)。在 `plugin.json` 中显式声明会导致重复检测错误:
|
||
|
||
```
|
||
Duplicate hooks file detected: ./hooks/hooks.json resolves to already-loaded file
|
||
```
|
||
|
||
**历史背景:** 这已导致此仓库中多次修复/还原循环([#29](https://github.com/affaan-m/everything-claude-code/issues/29), [#52](https://github.com/affaan-m/everything-claude-code/issues/52), [#103](https://github.com/affaan-m/everything-claude-code/issues/103))。Claude Code 版本之间的行为发生了变化,导致了混淆。我们现在有一个回归测试来防止这种情况再次发生。
|
||
|
||
***
|
||
|
||
## 📥 安装
|
||
|
||
### 选项 1:作为插件安装(推荐)
|
||
|
||
使用此仓库的最简单方式 - 作为 Claude Code 插件安装:
|
||
|
||
```bash
|
||
# Add this repo as a marketplace
|
||
/plugin marketplace add affaan-m/everything-claude-code
|
||
|
||
# Install the plugin
|
||
/plugin install everything-claude-code@everything-claude-code
|
||
```
|
||
|
||
或者直接添加到您的 `~/.claude/settings.json`:
|
||
|
||
```json
|
||
{
|
||
"extraKnownMarketplaces": {
|
||
"everything-claude-code": {
|
||
"source": {
|
||
"source": "github",
|
||
"repo": "affaan-m/everything-claude-code"
|
||
}
|
||
}
|
||
},
|
||
"enabledPlugins": {
|
||
"everything-claude-code@everything-claude-code": true
|
||
}
|
||
}
|
||
```
|
||
|
||
这将使您能够立即访问所有命令、代理、技能和钩子。
|
||
|
||
> **注意:** Claude Code 插件系统不支持通过插件分发 `rules`([上游限制](https://code.claude.com/docs/en/plugins-reference))。您需要手动安装规则:
|
||
>
|
||
> ```bash
|
||
> # 首先克隆仓库
|
||
> git clone https://github.com/affaan-m/everything-claude-code.git
|
||
>
|
||
> # 选项 A:用户级规则(适用于所有项目)
|
||
> cp -r everything-claude-code/rules/* ~/.claude/rules/
|
||
>
|
||
> # 选项 B:项目级规则(仅适用于当前项目)
|
||
> mkdir -p .claude/rules
|
||
> cp -r everything-claude-code/rules/* .claude/rules/
|
||
> ```
|
||
|
||
***
|
||
|
||
### 🔧 选项 2:手动安装
|
||
|
||
如果您希望对安装的内容进行手动控制:
|
||
|
||
```bash
|
||
# Clone the repo
|
||
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 commands
|
||
cp everything-claude-code/commands/*.md ~/.claude/commands/
|
||
|
||
# Copy skills
|
||
cp -r everything-claude-code/skills/* ~/.claude/skills/
|
||
```
|
||
|
||
#### 将钩子添加到 settings.json
|
||
|
||
将 `hooks/hooks.json` 中的钩子复制到你的 `~/.claude/settings.json`。
|
||
|
||
#### 配置 MCPs
|
||
|
||
将 `mcp-configs/mcp-servers.json` 中所需的 MCP 服务器复制到你的 `~/.claude.json`。
|
||
|
||
**重要:** 将 `YOUR_*_HERE` 占位符替换为你实际的 API 密钥。
|
||
|
||
***
|
||
|
||
## 🎯 关键概念
|
||
|
||
### 智能体
|
||
|
||
子智能体处理具有有限范围的委托任务。示例:
|
||
|
||
```markdown
|
||
---
|
||
name: code-reviewer
|
||
description: 审查代码的质量、安全性和可维护性
|
||
tools: ["Read", "Grep", "Glob", "Bash"]
|
||
model: opus
|
||
---
|
||
|
||
您是一位资深代码审查员...
|
||
|
||
```
|
||
|
||
### 技能
|
||
|
||
技能是由命令或智能体调用的工作流定义:
|
||
|
||
```markdown
|
||
# TDD Workflow
|
||
|
||
1. Define interfaces first
|
||
2. Write failing tests (RED)
|
||
3. Implement minimal code (GREEN)
|
||
4. Refactor (IMPROVE)
|
||
5. Verify 80%+ coverage
|
||
```
|
||
|
||
### 钩子
|
||
|
||
钩子在工具事件上触发。示例 - 警告关于 console.log:
|
||
|
||
```json
|
||
{
|
||
"matcher": "tool == \"Edit\" && tool_input.file_path matches \"\\\\.(ts|tsx|js|jsx)$\"",
|
||
"hooks": [{
|
||
"type": "command",
|
||
"command": "#!/bin/bash\ngrep -n 'console\\.log' \"$file_path\" && echo '[Hook] Remove console.log' >&2"
|
||
}]
|
||
}
|
||
```
|
||
|
||
### 规则
|
||
|
||
规则是始终遵循的指导原则。保持其模块化:
|
||
|
||
```
|
||
~/.claude/rules/
|
||
security.md # No hardcoded secrets
|
||
coding-style.md # Immutability, file limits
|
||
testing.md # TDD, coverage requirements
|
||
```
|
||
|
||
***
|
||
|
||
## 🧪 运行测试
|
||
|
||
该插件包含一个全面的测试套件:
|
||
|
||
```bash
|
||
# Run all tests
|
||
node tests/run-all.js
|
||
|
||
# Run individual test files
|
||
node tests/lib/utils.test.js
|
||
node tests/lib/package-manager.test.js
|
||
node tests/hooks/hooks.test.js
|
||
```
|
||
|
||
***
|
||
|
||
## 🤝 贡献
|
||
|
||
**欢迎并鼓励贡献。**
|
||
|
||
此仓库旨在成为社区资源。如果你有:
|
||
|
||
* 有用的智能体或技能
|
||
* 巧妙的钩子
|
||
* 更好的 MCP 配置
|
||
* 改进的规则
|
||
|
||
请贡献!请参阅 [CONTRIBUTING.md](CONTRIBUTING.md) 了解指南。
|
||
|
||
### 贡献想法
|
||
|
||
* 特定语言的技能(Python、Rust 模式)- 现已包含 Go!
|
||
* 特定框架的配置(Django、Rails、Laravel)
|
||
* DevOps 代理(Kubernetes、Terraform、AWS)
|
||
* 测试策略(不同框架)
|
||
* 特定领域的知识(ML、数据工程、移动开发)
|
||
|
||
***
|
||
|
||
## 📖 背景
|
||
|
||
我从实验性推出以来就一直在使用 Claude Code。在 2025 年 9 月,与 [@DRodriguezFX](https://x.com/DRodriguezFX) 一起使用 Claude Code 构建 [zenith.chat](https://zenith.chat),赢得了 Anthropic x Forum Ventures 黑客马拉松。
|
||
|
||
这些配置已在多个生产应用程序中经过实战测试。
|
||
|
||
***
|
||
|
||
## ⚠️ 重要说明
|
||
|
||
### 上下文窗口管理
|
||
|
||
**关键:** 不要一次性启用所有 MCP。启用过多工具后,你的 200k 上下文窗口可能会缩小到 70k。
|
||
|
||
经验法则:
|
||
|
||
* 配置 20-30 个 MCP
|
||
* 每个项目保持启用少于 10 个
|
||
* 活动工具少于 80 个
|
||
|
||
在项目配置中使用 `disabledMcpServers` 来禁用未使用的工具。
|
||
|
||
### 定制化
|
||
|
||
这些配置适用于我的工作流。你应该:
|
||
|
||
1. 从引起共鸣的部分开始
|
||
2. 根据你的技术栈进行修改
|
||
3. 移除你不使用的部分
|
||
4. 添加你自己的模式
|
||
|
||
***
|
||
|
||
## 🌟 Star 历史
|
||
|
||
[](https://star-history.com/#affaan-m/everything-claude-code\&Date)
|
||
|
||
***
|
||
|
||
## 🔗 链接
|
||
|
||
* **简明指南(从此开始):** [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)
|
||
|
||
***
|
||
|
||
## 📄 许可证
|
||
|
||
MIT - 自由使用,根据需要修改,如果可以请回馈贡献。
|
||
|
||
***
|
||
|
||
**如果此仓库对你有帮助,请点星。阅读两份指南。构建伟大的东西。**
|