About tidy
tidy is a codebase cleanup skill for coding agents, focused on reducing noise through rule consolidation, removal of obsolete material, and a file-size commit hook. It presents each proposed change for user approval before acting.
Key features
- 01Consolidate duplicate business rules
- 02Remove dead code and stale docs
- 03Add a pre-commit file-size hook
- 04Trim AGENTS.md and review tools
- 05Report cleanup using a template
Use cases
- 01Consolidate duplicated business rules
- 02Remove confirmed-unused code
- 03Block oversized files at commit
- 04Reduce project guidance for agents
Install
Copy the command and run it in a terminal.
npx skills add https:/ / github.com/ nagi-studio/ skills --skill tidyAfter installing, type/tidyin Claude Code to confirm it loaded.
Bundled filesagents/openai.yaml
Details
From the project READMEAgent 变笨,多半是它每次读到的东西太多、太旧、太乱。这一次只做减法:合并、删除、拦住,不加新功能。
每一步先把要改的列给用户看,用户点头再动手。删掉的东西 git 里都还在,确认没人引用就可以删。
1. 同一条规矩只放一处
找出业务规则(算不算迟到、价格怎么算、谁能看什么)分别写在了哪几处。同一条规则出现在两处以上,就收到一个地方,其他地方改成调用它。代码长得像、管的却是不同的事,就各留各的。
做完的标准:每条业务规则只剩一个出处,测试照样通过。
2. 清废料
- 死代码:没有任何地方引用的文件、函数、导出,搜索确认后删掉。
- 注释:复述代码的删掉,讲「为什么这么做」的留下;和代码对不上的,照代码改过来。
- 过时的文档:已经做完或作废的草稿、计划、旧版说明,删掉。
3. 装文件大小钩子
用 Git 的提交前钩子:提交的文件超过 5,000 token(字节数 ÷ 4,约 20 KB)就拒绝提交,报错写明这个文件多大,请按功能拆成几个文件。lockfile、自动生成的代码、构建产物这类 agent 不会去读的文件,跳过不查。项目已经在用 husky、lefthook、pre-commit 这类工具的,加在它里面。
装好后拿一个超标的文件试:提交必须被拦下,拆完再提交必须通过。已经超标的文件列出来交给用户,这一步不顺手去拆。
再在 AGENTS.md 里写两行:提交被钩子拒了,照报错拆文件再提交;写新函数、新规则前,先搜项目里有没有现成的。
4. AGENTS.md 和工具瘦身
- AGENTS.md 压到 100 行左右:留下项目是做什么的、这个项目特有的坑、指向
docs/的路标。看一眼目录、package.json或--help就知道的删掉;长篇细节挪进docs/,在 AGENTS.md 里用一行指过去。 - 工具:列出全局装着、但这个项目用不上的 MCP、skill 和插件,建议用户改成只在需要的项目里开。全局配置交给用户自己改。
- 老犯的错:同一个错 agent 犯了两次以上,加一条 lint 规则或测试拦住,不往 AGENTS.md 里写提醒。
- 记忆插件:写代码时建议用户关掉,最新的代码和 git 记录就是记忆。
5. 交差
规矩收拢:<规则> → <路径>(原来 N 处)
删掉:N 个文件,N 行
钩子:<装在哪>;超标文件被拦下、拆完通过
AGENTS.md:N 行 → N 行
建议关掉的工具:…;没有就写「无」
还超标、没拆的文件:…;没有就写「无」
最后告诉用户以后的三个习惯:读代码、搜资料交给 sub-agent,只带回结论;聊长了就 /compact;换任务就清空,开一个新对话。