本文档教你如何在 Codex、Claude Code、Trae、WorkBuddy 等 AI 编程工具中加载并使用本 Skill（
xiunox-plugin-dev），让 AI 自动遵循 XIUNOX 插件开发规范。
这个 Skill 是什么？
本目录是一个 AI 编程助手 Skill/Rule 包，包含了：
SKILL.md—— 主入口（含触发条件、硬规则、工作流）references/—— 速查手册（API、Hooks、安全、UI 等）
将本 Skill 挂载到你的 AI 工具后，当你要求“写一个 XIUNOX 插件”、“加一个 hook”、“加后台设置页”时，AI 会自动参考这些规范，避免写出白屏、数据错乱或不合规范的代码。
各工具集成方法
1. Trae（原生 Skill 支持）
Trae 是 原生支持本 Skill 格式（frontmatter 触发）的工具。
操作步骤：
将本 Skill 目录（或整个
docs/）放入项目根目录下的.trae/skills/：将本 rules（解压后）放入项目根目录下的
.trae/rules/：text
项目根目录/ └── .trae/ └── skills/ └── xiunox-plugin-dev/ # 本目录整体放入 ├── SKILL.md └── references/或在 Trae 设置中手动导入本目录。
之后在聊天框中直接说需求（如“帮我给用户页加个积分显示插件”），Trae 会自动匹配 frontmatter 中的
description并加载 Skill。
💡 替代方式：你也可以将
SKILL.md和references/*.md全部复制到.trae/rules/目录下作为全局规则，这样每次对话都会自动加载（但略占上下文）。
2. Claude Code（Anthropic 官方 CLI）
Claude Code 通过项目根目录的 CLAUDE.md 文件注入上下文。
操作步骤：
在项目根目录创建或编辑
CLAUDE.md，写入以下内容：markdown
# XIUNOX 插件开发规范 请严格遵循项目文档中的 XIUNOX 插件开发规范。 相关规范文档位于： - docs/skill/SKILL.md（核心规则与工作流） - docs/skill/references/（API/Hooks/安全/UI 速查） 当用户要求编写或修改 XIUNOX 插件时，请先阅读上述文档再生成代码。或者在启动 Claude Code 时通过命令行显式加载：
bash
claude --file docs/skill/SKILL.md之后在会话中，AI 会参考这些文件。
进阶用法：将整个
references/目录内容按需粘贴到对话中，或让 AI 在生成代码前主动读取这些文件（前提是你告诉它这些文件的存在）。
3. Codex（OpenAI CLI）
Codex 支持通过 --instructions 或项目中的 CODEX.md 注入系统提示。
操作步骤：
方式一（项目文件）：在项目根目录创建
CODEX.md，内容同上述CLAUDE.md，指明规范文件位置。方式二（命令行）：
bash
codex --instructions docs/skill/SKILL.md之后在 Codex 会话中输入插件开发需求，它会自动加载指令。
⚠️ Codex 上下文窗口有限，如果
references/太大，建议仅在需要时让 AI 按需读取（如：“查看 references/api-cheatsheet.md 中的 Db::insert 签名”）。
4. WorkBuddy / 通用 AI 工作台
WorkBuddy 等工具通常支持 知识库索引 或 对话附件上传。
操作步骤：
知识库模式：在 WorkBuddy 后台新建知识库，将本目录所有
.md文件上传并索引。之后在对话中引用该知识库即可。附件模式：在每次对话中，将
SKILL.md和相关的references/*.md作为附件上传，并提示 AI：“请先阅读这些规范，再帮我写插件代码”。提示词模板：
text
请扮演 XIUNOX 插件开发专家。所有代码必须严格遵守附件中的规范： - 禁止 hook 文件内 return; - 必须带 CSRF 校验 - 模型调用用单下划线业务层 （附件：SKILL.md + references/ 下相关文件）
通用最佳实践（不限工具）
无论用哪种工具，遵循以下原则可最大化 Skill 效果：
操作 | 说明 |
|---|---|
显式触发 | 每次提问时注明“按 XIUNOX 规范”、“参考 SKILL.md”，尤其是短对话。 |
按需引用 | 不必一次性加载全部 |
迭代修正 | 若 AI 生成代码违反规则（如写了 |
版本管理 | 将本 Skill 目录提交到项目仓库（如 Git），团队成员共享同一套规范。 |
示例对话（以 Trae 为例）
用户：
我要写一个插件，在用户个人资料页显示一个“今日签到”按钮，点击后积分 +1，一天限一次。按 XIUNOX 规范来。
AI（加载 Skill 后）：
自动检索
hooks-catalog.md找到user_profile_afterhook检索
api-cheatsheet.md找到Db::get_lock（防并发）和kv_get（记录签到状态）检索
security-patterns.md应用幂等 + 频率限制生成完整的
plugin/signin/骨架，包含install.php、hook/、route/、view/htm/，并带 CSRF 校验。
故障排查
问题 | 解决方案 |
|---|---|
AI 不读规范，乱写代码 | 检查 Skill 是否正确挂载；在 prompt 中显式加一句“严格遵循 docs/skill/SKILL.md 硬规则”。 |
上下文窗口超限 | 不要全量加载 |
Trae 不触发 Skill | 确认 frontmatter 中的 |
代码仍出现 | 这是最顽固的错误，在 review 时专门加一条指令：“检查所有 hook 文件，确保没有 return;”。 |
开源及下载地址：
