@dreadedzombie/pi-init
为项目生成类型化的AGENTS.md文档
安装使用
复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:
帮我安装这个 AI Skill:@dreadedzombie/pi-init。 它的用途是:为项目生成类型化的AGENTS.md文档 详细介绍见:https://321skill.com/skills/dreadedzombie-pi-init/ 请根据该页面的说明完成安装。
使用示例
“请为我的项目生成AGENTS.md文档。” 它会自动扫描项目中的Agent指令定义,并生成一份包含所有指令(如`/init`、`/init debug`)及其详细说明、参数和示例的Markdown文件。开发者可以将此文件纳入版本控制,方便团队随时查阅。
介绍
这个Skill解决了AI Agent项目中,团队成员对可用指令(Slash Commands)及其功能、参数缺乏统一、清晰文档的问题。它通过分析项目代码,自动生成一份类型化的AGENTS.md文件,清晰列出所有可用的指令(如/init、/init research)、它们的用途、参数类型和示例,使团队协作更顺畅。
使用时,开发者只需在项目中运行该Skill,它会扫描代码结构,识别出所有定义的Agent指令,并自动生成或更新AGENTS.md文件。这份文档会以结构化的方式呈现,方便团队成员随时查阅,了解当前项目支持哪些AI指令以及如何正确使用它们。
它非常适合正在使用或开发基于AI Agent(如Claude、Cursor等)协作工具的项目团队,尤其是当项目规模增长、指令繁多且由不同成员维护时。对于开源项目,它也能让贡献者快速上手。
建议在项目开发初期或每次新增、修改Agent指令后运行此Skill,以保持文档的实时性。注意,它依赖于项目代码中对指令的规范定义,如果指令定义方式不标准,可能需要手动调整或补充文档内容。
核心特点
与手动维护或通用文档生成器不同,它专门针对AI Agent项目的Slash Commands进行深度解析和类型化文档生成,能自动提取指令的语义和参数结构,生成比简单列表更精确、更具指导性的文档。
注意事项
不适合用于非AI Agent项目,或指令定义非常不规范、无法被自动解析的项目。
常见问题
这个Skill支持哪些AI开发平台?
它主要面向使用类似Slash Command机制的AI Agent开发框架或环境,如基于Claude、Cursor等工具定制的项目。
生成的AGENTS.md文件可以自定义格式吗?
目前主要生成固定的类型化Markdown格式,侧重于清晰展示指令、参数和用途,自定义选项有限。