skill安装
Lovrabet skill是一套为 AI IDE 定制的开发规范和指南,帮助 AI 正确使用 Lovrabet SDK 和 CLI,减少错误代码,提高开发效率。
什么是skill?
skill包含:
| 技能 | 说明 |
|---|---|
| TypeScript SDK 使用指南 | Filter、SQL、BFF 三大核心 API 使用规范 |
| MCP SQL 创建工作流 | 5 步强制流程,创建自定义 SQL 查询 |
| AntD UI 开发规范 | 避免生成 "AI 味道" 的 UI 代码 |
| API 集成指南 | lovrabet api pull 流程和使用 |
| 菜单管理指南 | menu sync/update 流程 |
| Backend Function 脚本编写规范 | 权限过滤、数据脱敏、业务逻辑 |
安装后的文件结构
your-project/
├── .cursorrules # Cursor 通用规则
├── .cursor/
│ └── skills/ # Cursor 技能
├── .windsurf/
│ └── workflows/ # Windsurf 工作流
├── .claude/
│ └── skills/ # Claude Code 技能
├── .lovrabet/
│ ├── skill-manifest.json # skill清单
│ └── skill/
│ └── .shared/
│ └── guides/ # 共享指南
│ ├── 01-typescript-sdk/guide.md
│ ├── 02-mcp-sql-workflow/guide.md
│ ├── 03-antd-style/guide.md
│ ├── 05-api-integration/guide.md
│ ├── 06-menu-management/guide.md
│ └── 07-backend-function/guide.md
└── agents.md # Claude Code 规则
支持的 IDE
| IDE | 配置位置 | 命令参数 |
|---|---|---|
| Cursor | .cursorrules, .cursor/ | --cursor |
| Windsurf | .windsurf/ | --windsurf |
| Claude Code | .claude/, agents.md | --claude |
| Codex | .codex/ | --codex |
| OpenCode | .opencode/ | --opencode |
| Qoder | .qoder/ | --qoder |
| CodeBuddy | .codebuddy/ | --codebuddy |
| Trae | .trae/ | --trae |
| 通用/其他 | .agent/ | --agent |
| 全部 | 所有以上 | --all |
安装方式
交互式安装
lovrabet skill install
然后选择要安装的 IDE(支持多选):
请选择要安装skill的 IDE (可多选):
1. Cursor - Cursor IDE (.cursorrules + .cursor/skills/)
2. Windsurf - Windsurf IDE (.windsurf/workflows/)
3. claude code - claude code (.claude/skills/)
4. Codex - Codex IDE (.codex/skills/)
5. OpenCode - OpenCode IDE (.opencode/skills/)
6. Qoder - Qoder IDE (.qoder/rules/ + .qoder/skills/)
7. CodeBuddy - CodeBuddy IDE (.codebuddy/skills/)
8. Trae - Trae IDE (.trae/skills/)
0. 全部安装
q. 取消
输入格式: 输入编号,用空格分隔 (例如: 1 3 5)
请选择:
直接安装指定 IDE
# 安装 Cursor skill
lovrabet skill install --cursor
# 安装多个 IDE
lovrabet skill install --cursor claude
# 安装所有
lovrabet skill install --all
技能内容详解
1. TypeScript SDK 使用指南
掌握 Lovrabet SDK 的三大核心 API:Filter、SQL、BFF。
包含内容:
- Filter 高级查询 - 复杂条件筛选、字段选择、排序
- SQL 自定义查询 - 执行已注册的 SQL 查询
- BFF 端点调用 - 调用后端函数
- 三大 API 对比和使用场景
- 错误处理最佳实践
示例对比:
// Filter - 数据集高级查询
const result = await client.models.users.filter({
where: { status: { $eq: 'active' } },
select: ['id', 'name'],
currentPage: 1,
pageSize: 20,
});
// SQL - 自定义查询
const data = await client.sql.execute({
sqlCode: 'fc8e7777-06e3847d',
params: { userId: '123' }
});
// BFF - 后端函数调用
const result = await client.bff.execute({
scriptName: 'getUserDashboard',
params: { userId: '123' }
});
2. MCP SQL 创建工作流
掌握创建自定义 SQL 的 5 步流程。
流程步骤:
- 使用 MCP 获取数据集信息
- 确定查询需求和字段
- 在平台创建自定义 SQL
- 使用 SDK executeSql() 调用
- 处理结果和错误
3. AntD UI 开发规范
统一 AntD 组件使用风格,避免 "AI 味道"。
规范内容:
- 组件选择原则
- 样式约定
- 表格配置规范
- 表单布局规范
4. API 集成指南
使用 lovrabet api pull 集成数据集 API。
流程说明:
- 初始化项目配置
- 拉取 API 配置
- 生成 API 文档
- 在代码中使用
5. 菜单管理指南
使用 lovrabet menu sync/update 管理菜单。
流程说明:
- 开发新页面
- 同步菜单到平台
- 更新 CDN 资源
6. Backend Function 脚本编写规范
编写后端函数脚本的规范。
规范内容:
- 权限过滤
- 数据脱敏
- 业务逻辑封装
- 错误处理
查看已安装的技能
# 查看 manifest
cat .lovrabet/skill-manifest.json
# 查看指南目录
ls .lovrabet/skill/.shared/guides/
# 阅读特定指南
cat .lovrabet/skill/.shared/guides/01-typescript-sdk/guide.md
更新skill
skill会随 CLI 版本更新。要更新到最新版本:
# 重新安装
lovrabet skill install --cursor
# CLI 会覆盖现有文件,更新到最新版本
与 MCP 配合使用
skill与 MCP 配合使用效果更佳:
# 1. 安装skill
lovrabet skill install --cursor
# 2. 配置 MCP
lovrabet mcp install cursor
配合效果:
- MCP 让 AI 能访问数据集信息
- skill教 AI 如何正确使用 SDK
- 两者结合,AI 可以生成更准确的代码
故障排查
问题:技能文件未生效
检查项:
- 确认文件已创建
- 重启 IDE
- 检查 IDE 是否支持该格式的规则文件
解决方法:
# 检查文件是否存在
ls -la .cursorrules
ls -la .lovrabet/skill/.shared/guides/
# 重新安装
lovrabet skill install --cursor
问题:IDE 不识别规则文件
不同 IDE 对规则文件的支持不同:
- Cursor: 支持
.cursorrules和.cursor/skills/ - Windsurf: 支持
.windsurf/workflows/ - Claude Code: 支持
.claude/skills/和agents.md
如果 IDE 不识别,请检查 IDE 版本和文档。
相关文档
- MCP 配置 - 配置 MCP 服务器
- 命令参考 - 所有 CLI 命令
- TypeScript SDK 快速开始 - SDK 安装和基础使用
- Filter API 指南 - Filter 高级查询完整指南
- SQL API 指南 - SQL 自定义查询使用指南