Skip to content

Latest commit

 

History

History
643 lines (447 loc) · 11.9 KB

File metadata and controls

643 lines (447 loc) · 11.9 KB

Everything Claude Code 新手入门教程

Anthropic Hackathon 获奖作品 - AI Agent 性能优化系统

目录


什么是 Everything Claude Code?

Everything Claude Code (ECC) 是一个 AI Agent 性能优化系统,来自 Anthropic Hackathon 获奖者。它不仅仅是配置文件,而是一个完整的系统,包含:

核心组件

组件 功能 示例
Agents 专业子 Agent 委托 planner, code-reviewer, tdd-guide
Skills 工作流定义和领域知识 coding-standards, testing, security
Commands 斜杠命令 /tdd, /plan, /e2e, /code-review
Hooks 触发自动化 session-persistence, pre/post-tool
Rules 始终遵循的指南 security, coding-style
MCP Configs 外部集成配置 数据库、API、工具集成

核心理念

  • Token 优化:模型选择、系统提示精简、后台进程
  • 记忆持久化:跨会话自动保存/加载上下文
  • 持续学习:从会话中自动提取模式到可复用技能
  • 验证循环:检查点 vs 持续评估
  • 并行化:Git worktrees、级联方法
  • 子 Agent 编排:迭代检索模式解决上下文问题

安装 Everything Claude Code

方式一:官方安装脚本(推荐)

# 克隆仓库
git clone https://github.com/affaan-m/everything-claude-code.git

# 进入目录
cd everything-claude-code

# 运行安装脚本
./install.sh

方式二:手动安装

# 复制到 Claude Code 技能目录
cp -r . ~/.claude/skills/everything-claude-code

# 或安装到项目
mkdir -p .claude/skills
cp -r . .claude/skills/everything-claude-code

方式三:npm 包安装

# 全局安装
npm install -g ecc-universal

# 运行
ecc install

验证安装

在 Claude Code 中输入:

/tdd

如果看到 TDD 工作流提示,说明安装成功!


核心概念

1. Agents(代理)

ECC 提供了 20+ 专业 Agent,可以委托给它们完成特定任务:

Agent 功能 适用场景
planner 实现规划 复杂功能设计
code-reviewer 代码审查 代码质量检查
tdd-guide TDD 指导 测试驱动开发
security-reviewer 安全分析 安全漏洞检测
build-error-resolver 构建修复 TypeScript/编译错误
e2e-runner E2E 测试 关键流程测试

使用方式

请使用 planner agent 帮我规划这个功能的实现

2. Skills(技能)

Skills 是工作流定义和领域知识:

Skill 功能
coding-standards 编码标准
testing 测试指南
security 安全指南
performance 性能优化
memory-optimization 记忆优化

3. Commands(命令)

斜杠命令是快速触发工作流的方式:

命令 功能
/tdd 测试驱动开发工作流
/plan 实现规划
/e2e 生成并运行 E2E 测试
/code-review 质量审查
/build-fix 修复构建错误
/learn 从会话中提取模式
/skill-create 从 git 历史生成技能

4. Hooks(钩子)

Hooks 是触发式自动化:

Hook 功能
session-start 会话启动时加载上下文
session-stop 会话结束时保存状态
pre-edit 编辑前检查
post-edit 编辑后格式化
pre-commit 提交前验证

5. Rules(规则)

Rules 是始终遵循的指南:

  • 安全规则:输入验证、SQL 注入防护、XSS 防护
  • 编码风格:Immutability、文件组织、错误处理
  • 测试要求:80% 覆盖率、单元测试、集成测试、E2E 测试

核心功能

1. Token 优化

ECC 帮助你在保持功能的同时减少 Token 使用:

模型选择策略

  • Haiku:轻量 Agent,频繁调用 → 3x 节省
  • Sonnet:主开发工作 → 最佳平衡
  • Opus:复杂架构决策 → 最强推理

系统提示精简

使用 /learn 技能从历史会话中提取模式
→ 自动精简系统提示
→ 减少 30-50% Token 消耗

2. 记忆持久化

ECC 自动保存和加载跨会话上下文:

会话启动时

  • 自动加载上次的项目状态
  • 恢复未完成的任务
  • 加载相关文档

会话结束时

  • 自动保存当前进度
  • 记录关键决策
  • 更新知识库

配置方式

settings.json 中启用:

{
  "hooks": {
    "sessionPersistence": {
      "enabled": true,
      "loadOnStart": true,
      "saveOnStop": true
    }
  }
}

3. 持续学习

ECC 可以从会话中自动提取模式:

使用 /learn 命令

/learn

ECC 会:

  1. 分析最近会话
  2. 提取可复用的模式
  3. 生成新技能或更新现有技能
  4. 保存到知识库

自动模式提取

检测到重复模式:
- 数据库连接错误处理
- API 响应验证
- 用户输入 sanitization

自动生成技能:
- db-error-handler
- api-response-validator
- input-sanitizer

4. 验证循环

ECC 提供两种验证方式:

验证类型 用途 成本
检查点验证 单点验证,快速反馈
持续评估 完整测试,深度验证

使用方式

/verify  // 检查点验证
/eval    // 持续评估

5. 并行化

ECC 支持多工作树并行开发:

创建工作树

/worktree create feature/new-feature

并行执行

在 feature/user-auth 分支运行 /review
在 feature/api-v2 分支运行 /e2e
在 feature/ui-redesign 分支运行 /design-review

6. 子 Agent 编排

ECC 解决子 Agent 上下文问题:

问题:子 Agent 无法访问主会话上下文

解决:迭代检索模式

1. 主 Agent 定义任务
2. 子 Agent 执行
3. 主 Agent 审查
4. 迭代改进
5. 最终合并

用户案例

案例 1:使用 TDD 开发功能

让我们看如何使用 ECC 的 TDD 工作流。

第一步:开始 TDD

你输入

/tdd

ECC 响应

## TDD 工作流

我将引导你完成 RED-GREEN-REFACTOR 循环:

1. 先写一个失败的测试 (RED)
2. 写最少的代码让测试通过 (GREEN)
3. 重构 (REFACTOR)

请告诉我你要测试的功能:

你回答:用户登录功能

第二步:写测试

ECC 引导

## 测试 1: 用户登录

请编写一个失败的测试:

```javascript
test('should login with valid credentials', () => {
  const user = login('valid@email.com', 'password123')
  expect(user.isLoggedIn).toBe(true)
})

运行测试 → FAIL ❌ (因为 login 函数还不存在)


#### 第三步:写最少的代码

**你编写代码**:

```javascript
function login(email, password) {
  return { isLoggedIn: true }
}

运行测试 → PASS ✅

第四步:重构

ECC 提示

## 重构机会

当前代码:
- 没有实际验证
- 没有错误处理
- 没有返回值

建议重构:
1. 添加实际验证逻辑
2. 添加错误处理
3. 返回用户对象

是否继续重构?

你回答:是

第五步:完成

ECC 输出

## TDD 完成

✓ 测试通过
✓ 重构完成
✓ 提交已生成

下一步:
- 运行 /code-review 审查代码
- 运行 /e2e 测试端到端流程

案例 2:使用 /plan 规划项目

第一步:启动规划

你输入

/plan

ECC 响应

## 实现规划

请描述你要实现的功能:

你回答:一个博客系统,包括文章 CRUD、评论、标签功能

第二步:分析需求

ECC 分析

## 需求分析

### 核心功能
1. 文章 CRUD
2. 评论系统
3. 标签系统

### 技术栈
- 后端: Node.js + Express
- 数据库: PostgreSQL
- 前端: React

### 任务拆分

#### Phase 1: 后端 API (2 小时)
- [ ] 项目初始化
- [ ] 数据库连接
- [ ] 文章 CRUD
- [ ] 评论 CRUD
- [ ] 标签 CRUD

#### Phase 2: 前端 (3 小时)
- [ ] 项目初始化
- [ ] 文章列表页
- [ ] 文章详情页
- [ ] 评论组件
- [ ] 标签组件

#### Phase 3: 测试 (1 小时)
- [ ] 单元测试
- [ ] 集成测试
- [ ] E2E 测试

第三步:执行计划

你输入:开始执行

ECC 执行

## 执行计划

### Phase 1: 后端
[Agent 1] 初始化项目... ✓
[Agent 2] 数据库连接... ✓
[Agent 3] 文章 CRUD... ✓
[Agent 4] 评论 CRUD... ✓

### 任务状态
✓ task-1.1: Initialize project
✓ task-1.2: Database connection
✓ task-1.3: Article CRUD

原子提交已生成...

案例 3:使用 /code-review 审查代码

第一步:启动审查

你输入

/code-review

ECC 执行

## 代码审查

### 正在分析...
- 文件: src/**/*.ts
- 审查点: 20+
- Agent: code-reviewer

### 审查结果

[Critical] 🔴
- ❌ src/auth/login.ts:45 - 密码明文存储
- ❌ src/api/user.ts:23 - SQL 注入风险

[High] 🟡
- ⚠️ src/utils/format.ts:12 - 缺少空值检查
- ⚠️ src/components/Button.tsx:8 - 未使用的 import

[Medium] 🟢
- 💡 src/config/index.ts - 日志可以更详细
- 💡 src/hooks/useAuth.ts - 可以添加缓存

### 建议
修复 Critical 问题后合并

第二步:修复问题

ECC 自动修复

[AUTO-FIXED]
✓ src/auth/login.ts - 添加密码哈希
✓ src/api/user.ts:23 - 使用参数化查询

请审查修复结果...

案例 4:使用 /learn 持续学习

第一步:启动学习

你输入

/learn

ECC 分析

## 持续学习

### 分析最近会话
- 总会话数: 15
- 提取模式: 8

### 检测到的模式

1. **数据库错误处理**
   - 出现: 5 次
   - 模式: try-catch + 重试
   - 建议: 生成 db-error-handler 技能

2. **API 响应验证**
   - 出现: 3 次
   - 模式: status + data 验证
   - 建议: 生成 api-response-validator 技能

3. **用户输入 sanitization**
   - 出现: 4 次
   - 模式: trim + escape
   - 建议: 生成 input-sanitizer 技能

第二步:生成技能

ECC 生成

## 生成的技能

### db-error-handler
位置: skills/db-error-handler/SKILL.md
功能:
- 检测数据库错误类型
- 自动重试策略
- 错误日志记录

### api-response-validator
位置: skills/api-response-validator/SKILL.md
功能:
- 验证 HTTP 状态码
- 验证响应数据结构
- 类型安全检查

是否保存这些技能?

常见问题

Q: ECC 要钱吗?

A: 免费!MIT 许可证。

Q: 和 gstack、Superpowers 有什么不同?

A:

项目 特点 适用场景
gstack 15 个专业角色,最完整 大型项目
Superpowers 自动化工作流,TDD 强制 流程自动化
Compound Engineering 复利工程,知识沉淀 持续改进
ECC Token 优化,记忆持久化 性能优化

Q: 支持哪些 AI 工具?

A:

  • Claude Code ✓
  • Codex ✓
  • Cowork ✓
  • Cursor (部分)
  • OpenCode (部分)

Q: 如何更新 ECC?

cd ~/.claude/skills/everything-claude-code
git pull origin main

Q: 可以自定义规则吗?

A: 可以。在 rules/ 目录下添加你的规则文件。

Q: Token 优化效果如何?

A: 根据使用场景:

  • 模型选择:节省 30-50%
  • 系统提示精简:节省 20-30%
  • 记忆持久化:节省 10-20%

总体可节省 60-90% 的 Token 消耗。


下一步

  • 阅读 ECC 完整文档
  • 尝试 /tdd 体验 TDD 工作流
  • 尝试 /learn 自动提取模式
  • 配置 Token 优化参数

准备好了?开始你的第一个 /tdd 吧! 🚀