Project Butler 项目管家
让 Claude Code、Cursor、Codex 等 AI 编程助手跨会话记住项目,而不是每次从零开始。
- Star 数
- ★ 374
- 最近更新
- 3 个月前
- License
- MIT
- 主语言
- Shell
- FA 评分
- 49/100 · 缺口较多
30 秒速览
- 运行形态
- 可在哪里用
- 兼容但需适配Claude CodeCodex(部分支持)Claude.ai(不支持)
- 费用
- 软件免费,模型调用费用自付
- 上手难度
- 低 · 几分钟可跑通
- 开始前需要
- 典型场景
- 长期用 Claude Code 迭代同一个代码库、每次会话都要重新讲一遍架构的开发者。
- 不适合
- 希望完全图形化操作、不愿维护 Markdown 项目文件的团队
- 只在 Cursor 或 Codex 中使用、又需要自动更新检查和完整运行时行为的用户
- 需要团队共享数据库型知识库而非仓库内纯文本记忆的项目
- 源码审查
- 49/100 · 缺口较多
这个 Agent 能做什么,适合哪些场景?
project-butler 是一个面向 AI 编程助手的项目记忆系统,以 Claude Code 技能的形式安装在 ~/.claude/skills/project-butler 下。它通过在项目根目录维护一组纯 Markdown 文件(CLAUDE.md、PROJECT.md、STRUCTURE.md、UPDATE_LOG.md、DOCS.md、session-handoff.md、TODO.md,以及 log/、docs/、.claude/ 目录)来记录规则、当前状态、待办、里程碑变更和会话日志。用户在会话结束时说“end session”保存进度,下次说“continue”即可恢复上下文,无需重新解释项目。内部按 7 个组件组织记忆栈:稳定规则、当前状态与原始事实自下而上汇总,top 约束 bottom。v1.6.0 起引入 Project Profile System,通过 .claude/project-profile.json 与 .claude/profile-pending.json 追踪文档分层、待办配置更新与 Normal Close / Full Close 行为。原生运行依赖 Claude Code 技能生命周期与 jq,Cursor 与 Codex 只能通过生成的规则文件进行尽力而为(best-effort)适配。
运行 /project-butler 时,技能在项目根目录创建或补齐 CLAUDE.md、PROJECT.md、STRUCTURE.md、UPDATE_LOG.md、DOCS.md、session-handoff.md、TODO.md,以及 docs/、log/、.claude/ 目录和 .claude/project-profile.json、.claude/profile-pending.json、.claude/candidates.md、.claude/.file-snapshot.json。工作过程中它把会话事实写入 log/,把待执行事项写入 TODO.md,把候选规则写入 .claude/candidates.md 等待用户通过 review claude 审核后才升格为长期规则。end session 会总结进展、刷新下一步、按用户选择的版本风格(Semantic / Codename / Patch / Date)写入 UPDATE_LOG.md。continue 与 continue full context 通过 jq 解析日志恢复上下文与完整项目轨迹。organize files 依据 STRUCTURE.md 执行四阶段(Discover、Ask or Plan、Plan、Execute)文件整理并遵守不删除策略。每次调用时技能还会对自身仓库执行 git fetch 并与 origin/main 比较 HEAD,判断是否落后并提示更新(可用 PROJECT_BUTLER_NO_UPDATE_CHECK=1 关闭)。
- 长期用 Claude Code 迭代同一个代码库、每次会话都要重新讲一遍架构的开发者。
- 在 Claude Code、Cursor、Codex 之间切换、希望三种工具读到同一份项目记忆的用户。
- 需要把架构决策、命名约定沉淀为可审核长期规则、而不是留在聊天记录里的团队。
- 项目文档散落在多个文件夹、希望按 STRUCTURE.md 自动整理并建立 DOCS.md 索引的维护者。
- 经常中断数周再回来、需要
continue full context重建项目全貌的个人开发者。 - 需要区分 Normal Close 与 Full Close、对产品/架构/路线图文档做受控更新的产品型项目。
如何安装或部署这个 Agent?
以 Claude Code 技能方式克隆到技能目录:
git clone https://github.com/JamesShi96/project-butler.git ~/.claude/skills/project-butler前置条件:需要 Claude Code CLI(原生技能执行)、jq(用于 continue / continue full context 会话恢复)。若在 v1.7.0 之前安装,需手动拉取一次以启用自动更新检查:
cd ~/.claude/skills/project-butler && git pull如需关闭自动更新检查:
export PROJECT_BUTLER_NO_UPDATE_CHECK=1非 Claude Code 环境下手动检查更新:
bash "${PROJECT_BUTLER_SKILL_DIR:-$HOME/.claude/skills/project-butler}/scripts/check-update.sh"没有独立的 /continue 命令需要安装,会话恢复由主技能内部路由。
如何使用这个 Agent?
打开任意项目后首次初始化:
/project-butler日常四个动作即可覆盖主要流程:
end session # 保存进度与下一步
continue # 下次直接接续上下文
status # 查看项目当前状态与建议的下一步高级用法:
continue full context # 长时间中断或换助手后重建完整轨迹
review claude # 审核候选规则
sync wiki # 强制刷新 PROJECT.md
organize files # 按 STRUCTURE.md 整理新文件
change language # 切换英文 / 中文 / 双语模式
normal close # 保存会话并把影响 profile 的更新推入待处理队列
full close # 在受限 Scope Plan 内立即对齐相关 profile 文档
profile setup # 创建或修复项目 profile 与基线参考文档这个 Agent 有哪些优点和局限?
- 核心产物是项目根目录的纯 Markdown 文件,不依赖专有格式,其他能读文件的助手也能复用同一份记忆。
- 区分“候选规则”和“长期规则”:.claude/candidates.md 需用户审核后才升格,避免 AI 自行改写项目宪法。
- 提供 Normal Close 与 Full Close 两种收尾模式,profile-aware 更新可在受限 Scope Plan 边界内进行,保护已冻结的基线章节。
- 四阶段文件整理明确采用“永不删除”的清理策略,降低自动整理误删的风险。
- 内置每日一次的 git fetch 版本检查并支持 PROJECT_BUTLER_NO_UPDATE_CHECK=1 静默,更新前必须由用户选择。
- 原生完整行为绑定 Claude Code 技能生命周期;Cursor 与 Codex 只能生成 .cursor/rules/project-system.mdc 或 AGENTS.md 做尽力而为的适配。
continue/continue full context依赖 jq,未安装 jq 时会话恢复链路会受阻。- 自动更新检查在技能目录执行 git fetch,会让该目录的 git status 显示落后于 origin/main。
- v1.7.0 之前安装的用户无法收到自动更新提示,必须手动 git pull 一次。
- 项目根目录会新增多个受管理的 Markdown 文件与 .claude/ 配置,对已有文档体系的仓库意味着一次结构迁移。
- 尚无英文以外界面本地化的完整证据,语言模式只覆盖项目文件命名与内容语言。
这个 Agent 与同类方案有什么区别?
与相关度最高的同类 agent 并排比较关键指标。
| Agent | 源码审查 | 形态 / 费用 | Star | 最近更新 | 主语言 | 完整支持的平台 |
|---|---|---|---|---|---|---|
| Project Butler 项目管家 当前 | 49 · 缺口较多 | Agent 插件 / 技能免费 + 模型费 | ★ 374 | 3 个月前 | Shell | Claude Code |
| RecallLoom 项目记忆 | 证据不足 | Agent 插件 / 技能免费 | ★ 153 | 3 个月前 | Python | Codex · Claude Code |
| Better Harness | 85 · 表现良好 | Agent 插件 / 技能免费 | ★ 2.4k | 16 天前 | JavaScript | Codex · Claude Code |
| Emulo | 78 · 表现良好 | Agent 插件 / 技能免费 + 模型费 | ★ 303 | 1 个月前 | HTML | Codex · Claude Code |
FollowAgents 如何评估这个 Agent?
查看各维度的扣分理由
README 显示更新检查会每日执行 git fetch 并可选 fast-forward pull,且明确要求用户确认后才拉取,属于较好的确认设计;但技能会写入项目根目录多个文件(CLAUDE.md、PROJECT.md 等)并读取项目内容,权限范围较宽,缺少对敏感数据(如日志中可能含密钥)的脱敏说明,依赖 jq 与 git 的安全评估未展开,回滚仅靠 git 与“不删除”策略,故各项多为 1-2 分。
README 内部描述较一致(命令、文件结构、更新日志相互对应),但依赖 jq、Claude Code CLI、git 等外部工具,缺少失败路径与错误信息的具体说明,仅提到更新失败时给出手动命令与 HTTPS 回退,故 reliability 中等偏低。
明确面向 Claude Code、Cursor、Codex 及其他可读文件的助手,场景与触发词(end session、continue、status)定义清晰,能力边界(Cursor/Codex 为 best-effort)有说明,环境适配较好;但缺少对非 Claude 环境的完整验证说明。
信息架构清晰,安装步骤具体,已知限制(更新检查 best-effort、旧版本无自动检查)有说明,LICENSE 为完整 MIT 文本;但示例与 FAQ 仅指向 docs/examples.md 未在证据中呈现,命名稳定性与维护责任(未验证发布者)证据不足,版本日志较完整。
输出为纯 Markdown 项目记忆文件,可被多工具读取,边际价值(跨会话记忆)明确;但成本收益依赖用户长期使用与手动触发,缺少量化证据,故中等。
README 的声明(自动更新、profile 系统、兼容性)多为主张,缺少测试或可复现证据;跨源佐证仅限 README 与 LICENSE,事实与推断分离不足。
- 更新检查会每日执行 git fetch 并可能 fast-forward pull,虽需确认,但在受限网络或私有仓库环境中可能产生意外副作用。
- 技能会向项目根目录写入多个文件并读取项目内容,日志可能包含敏感信息,缺少脱敏与访问控制说明。
- 依赖 jq、git 与 Claude Code CLI,未提供依赖版本约束或安全评估。
- 发布者身份未经验证,维护责任与更新路径不明确。
- README 中的兼容性与自动更新声明缺少测试或可复现证据。
最近版本
来自该项目 GitHub Releases 的最新发布记录,说明为上游原文摘录,未经本站改写或测试。
-
v1.7.3 v1.7.3 — Interactive Update Prompt + Project Profile System
发布说明摘录
First release since v1.4.0. It rolls up everything from v1.4.1 through v1.7.3 — two big additions (Project Profile System, version freshness check), a versioned update log, and a round of test-driven hardening. Highlights 🔔 Version freshness check (v1.7.0 → v1.7.3) project-butler now tells you when your installed copy is behind upstream. Every invocation starts with a cached check (at most one git fetch per machine per day) comparing local HEAD to origin/main. When you're behind, Claude Code asks once — and at most once every 24 hours: ``` …在 GitHub 查看 ↗ -
v1.4.0 v1.4.0 — Document Archiving System
发布说明摘录
Document Archiving System Add a document archiving layer to the project memory stack. New files: - docs/ directory — organized document storage with 6 preset type subdirectories - DOCS.md — document index with metadata (title, status, last updated, sub-doc hierarchy) - references/document-archiving.md — archiving protocol with auto-classification rules 6 preset document types (selected during init, extensible): - PRD, Tech Design, Design Docs, Research, Meeting Notes, Experiments End session integration: …在 GitHub 查看 ↗ -
v1.3.0 v1.3.0 — Four-Phase File Reorganization
发布说明摘录
Four-Phase File Reorganization Replaced template-based file reorganization with a project-understanding-driven flow. Mode A redesign (整理文件): - Four-phase flow: Discover → Ask or Plan → Plan → Execute - Phase 1 (Discover): structural signals first (glob/grep/imports), content reading only for uncertain files, then relationship inference to build a module map - Phase 2 (Ask or Plan): three-tier confidence routing — high confidence skips straight to plan, medium confidence (most common) focuses on specific issues, low confidence asks user about organizing dimensions …在 GitHub 查看 ↗
常见问题
它会自动修改我的现有文件吗?
不用 Claude Code 能用吗?
AI 会自己把规则写进 CLAUDE.md 吗?
review claude 或 check the rules 审核后才会成为长期规则。