根据您提供的GitHub仓库内容,ECC(Enhance your Claude Code) 是一个为AI编程助手(如Claude Code、Codex等)设计的性能优化系统。它通过提供技能、规则、记忆和专用Agent,将AI从单纯的代码生成器转变为一个拥有完整工程流程的系统。

以下是根据官方文档整理的详细部署教程。


🚀 第一步:准备工作

在开始安装前,请确认您的环境满足以下基本要求:

  1. Node.js: 版本 18 或更新。您可以在终端中运行 node -v 来检查版本。
  2. Git: 确保已安装并配置好。
  3. AI Agent (至少一个): ECC支持多个Agent,但其核心功能在Claude Code 2.1或更新版本上表现最佳。您需要确保目标Agent已安装并可在命令行(PATH)中直接调用。

⚙️ 第二步:选择并执行安装

ECC提供了多种安装方式以适应不同的Agent和工作流。

方式一:通用交互式引导安装 (最推荐)

这是最通用和简便的方法,特别适合首次安装或同时配置多个Agent的用户。它通过 npx 运行一个向导程序,引导您完成整个流程。

  1. 打开终端,执行以下命令:

    1
    npx ecc-universal install --guided
  2. 终端会启动一个交互式界面,您可以通过键盘方向键和空格键进行选择和确认。

  3. 在向导中,您可以选择要配置的Agent(如Claude Code, Codex, Kimi Code)以及安装的组件和配置选项。

    • 对于只想快速体验的用户:通常一路默认或选择 minimal 配置即可开始使用其核心功能。
    • 熟悉配置的用户:可以按需选择组件,例如指定 --claude-scope local --claude-hooks standard

方式二:为特定Agent快速安装

如果您只想为某一个Agent快速安装,可以使用特定的命令。

为 Claude Code 安装 (推荐方法)

在 Claude Code 内部,直接使用其原生插件命令是最佳实践:

  1. 在 Claude Code 会话中,先添加 ECC 的市场:
    /plugin marketplace add https://github.com/affaan-m/ECC
  2. 然后安装插件:
    /plugin install ecc@ecc

为 Codex 安装

在终端中执行以下命令:

1
2
codex plugin marketplace add affaan-m/ECC
codex plugin add ecc@ecc

为 Kimi Code 安装

在终端中执行:

1
bash ./install.sh --target kimi --profile minimal

🔧 第三步:安装后的配置与验证

  1. 运行自检命令: 完成安装后,在终端中执行以下命令来验证安装状态,并查看是否有任何需要手动修复的问题。

    1
    node scripts/ecc.js doctor

    或(如果通过 npx 安装的包):

    1
    npx ecc-universal doctor
  2. 手动复制规则 (仅限Claude Code插件): 如果你通过Claude Code插件方式安装,其 rules (规则) 不会自动分发。如需使用ECC的编码规范,需要手动复制:

    1
    2
    3
    4
    5
    6
    git clone https://github.com/affaan-m/ECC.git
    cd ECC
    mkdir -p ~/.claude/rules/ecc
    cp -R rules/common ~/.claude/rules/ecc/
    # 针对你使用的语言栈复制对应的规则,例如TypeScript:
    cp -R rules/typescript ~/.claude/rules/ecc/

    建议:只复制 rules/common 和与你项目相关的语言规则。

  3. 安装钩子 (Hooks): ECC的钩子功能可以实现会话摘要、持续学习等自动化操作。如果安装时未启用,可以后续单独添加:

    1
    bash ./install.sh --target claude --modules hooks-runtime --enable-hooks

📚 第四步:开始使用

安装完成后,您可以在AI Agent中通过特定的指令来调用ECC的功能。

常见工作流示例

  • 规划新功能: 在和Claude Code的对话中使用 /ecc:plan "描述你的功能需求"。这将会启动一个结构化的规划流程,产出可审查的方案。
  • 代码审查: 使用 /code-review 命令,让一个拥有“全新上下文”的AI Agent来审查你的代码改动。
  • 测试驱动开发 (TDD): 使用 tdd-workflow 技能(skill),强制遵循“红-绿-重构”的开发节奏。
  • 构建修复: 当项目构建失败时,使用 /build-fix 让AI协助诊断和修复问题。

查阅命令和技能

  • 输入 /ecc:plan 等带 ecc: 前缀的命令是插件的标准用法。
  • 若要查看ECC为你当前Agent安装的所有可用“技能”和“命令”,可以参考项目文档中的Commands Quick Reference

🧹 卸载或重置

如需重置配置或完全卸载,官方提供了安全的管理命令:

  1. 检查已安装的文件:

    1
    npx ecc-universal list-installed
  2. 尝试修复问题:

    1
    npx ecc-universal repair
  3. 执行卸载 (建议先使用 --dry-run 预览):

    1
    2
    npx ecc-universal uninstall --dry-run
    npx ecc-universal uninstall

重要提示: ECC包含了大量组件(68个专用Agent、286个技能等)。建议您先从基础工作流开始尝试,按需逐步探索,避免一次性加载所有功能而增加上下文负担。