AI 助手
vue3-element-admin 配套 Agent Skill,安装后 AI 编码工具自动遵循本项目的命名、目录结构、BEM + UnoCSS 边界、组件与 API 约定等规范,并掌握新增页面、配置路由、开发 CRUD 等操作指南,无需手动粘贴约定文档。
支持 CodeBuddy、Claude Code、Cursor、Codex、GitHub Copilot、Gemini CLI、Windsurf、Cline 等 70+ Agent。
安装
在 vue3-element-admin 项目根目录执行:
npx skills add https://github.com/youlaitech/youlai-skills --skill vue-adminCLI 自动检测系统中已安装的编码 Agent 并安装;检测到多个时会提示选择,也可用 --agent <name> 直接指定。
安装位置
skills add 有两种作用域:
| 作用域 | 标志 | 位置 | 用途 |
|---|---|---|---|
| 项目级(默认) | 无 | ./<agent>/skills/ | 随项目提交,团队共享 |
| 全局级 | -g / --global | ~/<agent>/skills/ | 跨项目复用 |
各 Agent 的项目级 skills 目录示例:
| Agent | 路径 |
|---|---|
| CodeBuddy | .codebuddy/skills/vue/SKILL.md |
| Claude Code | .claude/skills/vue/SKILL.md |
Cursor、Codex、Gemini CLI 等其他 Agent 写入各自的 skills 目录,具体路径以
skills add执行时的输出为准。全局安装对应~/.codebuddy/skills/、~/.claude/skills/等。
生成文件
安装后生成 vue/ 目录,内含一个 SKILL.md:
.claude/skills/vue/
└── SKILL.mdSKILL.md 结构:
---
name: vue
description: Vue 3 + TypeScript development standards ...
---
# Vue 3 开发规范
(命名、目录结构、CSS 边界、组件规范、API/Store 约定、反模式速查 ...)name 是 skill 唯一标识,description 告诉 Agent 何时使用该 skill;正文是 Agent 编码时遵循的指令。
Symlink 与 Copy
默认用 symlink 安装:各 Agent 目录软链接到同一份 skill 文件,更新时只需更新一处,所有 Agent 自动同步。
| 方式 | 标志 | 适用 |
|---|---|---|
| Symlink(默认) | 无 | 推荐,单一真值源 |
| Copy | --copy | 文件系统不支持 symlink(部分 Windows 配置) |
验证
安装后让 AI 助手在本项目生成一段组件或 API,应自动套用:组件 PascalCase、页面 index.vue、API 用 const XxxAPI = {} 对象字面量、类型无 VO/DTO 后缀等。详见代码规范。
Windows symlink 报错
加 --copy 参数,或以管理员身份运行终端开启符号链接权限。更新 skill 直接重新执行 skills add 命令,symlink 模式下自动覆盖。
