关于 explain
用于解释代码历史的技能,可将函数、文件和代码行变更的目的追溯到产生它们的对话。它借助 Entire 历史记录和会话 transcript,并检查 CLI 与提交是否可追溯。
主要功能
- 01将代码意图追溯到原始对话
- 02解释函数、文件和代码行变更
- 03通过 git 历史定位引入提交
- 04使用 Entire CLI 读取会话 transcript
适用场景
- 01了解添加某个函数的原因
- 02查找某个文件背后的需求
- 03调查特定代码变更的缘由
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ entireio/ skills --skill explain安装后在 Claude Code 中输入/explain确认已加载。
详细介绍
解释意图
追溯源代码的创建过程,还原其背后的原始对话,以解释代码意图。适用于:
- 函数 — 为什么需要这个函数?它要解决什么问题?
- 文件 — 这个文件的用途是什么?创建它的需求是什么?
- 行变更 — 为什么添加或修改了这一特定行?
响应格式
对此技能调用的首次响应,请以以下一行开头:
Entire Explain:
然后空一行,再写入内容。
- 此标题仅用于本次调用的首次响应。在后续对话轮次中(例如用户回答澄清问题后),不要再次输出。
- 对于错误或提前退出的响应(例如“必须安装 Entire CLI,但尚未安装”“此文件未纳入 git 跟踪”“未找到此提交的会话记录”),不要包含此标题。只有在技能已运行并生成实际结果时,才应包含此标题。
流程
- 运行
entire version,确认已安装entireCLI。- 如果找不到此命令,请停止并告知用户:“必须安装 Entire CLI,但尚未安装。请从 https://entire.io/docs/cli 安装,然后重试。”
- 使用 Haiku Agent,通过 git blame 或 git log 找出引入该代码的提交。
- 如果文件未纳入 git 跟踪,请停止并告知用户:“此文件未纳入 git 跟踪,因此无法追溯其历史记录。”
- 如果 git blame 未返回有用结果(例如,代码尚未提交),请停止并告知用户:“此代码尚未提交,因此没有可追溯的历史记录。”
- 使用 Sonnet Agent,通过
entire checkpoint explain --no-pager --commit COMMIT_SHA读取会话记录。- 如果命令失败或未返回会话记录,请停止并告知用户:“未找到此提交的会话记录。它可能是在 Entire 会话之外创建的(例如,通过手动提交)。”
评论
支持 Markdown