Skip to main content

Skill Installation

Lovrabet skill is a set of development specifications and guides customized for AI IDEs, helping AI correctly use Lovrabet SDK and CLI, reducing erroneous code and improving development efficiency.

What is a Skill?

Skills include:

SkillDescription
TypeScript SDK Usage GuideFilter, SQL, BFF three core API usage specifications
MCP SQL Creation Workflow5-step mandatory process for creating custom SQL queries
AntD UI Development SpecificationsAvoid generating "AI-flavored" UI code
API Integration Guidelovrabet api pull process and usage
Menu Management Guidemenu sync/update process
Backend Function Script Writing SpecificationsPermission filtering, data desensitization, business logic

File Structure After Installation

your-project/
├── .cursorrules # Cursor general rules
├── .cursor/
│ └── skills/ # Cursor skills
├── .windsurf/
│ └── workflows/ # Windsurf workflows
├── .claude/
│ └── skills/ # Claude Code skills
├── .lovrabet/
│ ├── skill-manifest.json # Skill manifest
│ └── skill/
│ └── .shared/
│ └── guides/ # 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 rules

Supported IDEs

IDEConfiguration LocationCommand Parameter
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
Generic/Other.agent/--agent
AllAll above--all

Installation Methods

Interactive Installation

lovrabet skill install

Then select the IDEs to install (supports multiple selections):

Please select IDEs to install skills for (multiple selections allowed):

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. Install all
q. Cancel

Input format: Enter numbers separated by spaces (e.g., 1 3 5)
Please select:

Direct Installation for Specific IDE

# Install Cursor skill
lovrabet skill install --cursor

# Install multiple IDEs
lovrabet skill install --cursor claude

# Install all
lovrabet skill install --all

Skill Content Details

1. TypeScript SDK Usage Guide

Master the three core APIs of Lovrabet SDK: Filter, SQL, BFF.

Includes:

  • Filter Advanced Queries - Complex condition filtering, field selection, sorting
  • SQL Custom Queries - Execute registered SQL queries
  • BFF Endpoint Calls - Call backend functions
  • Comparison and use cases of the three APIs
  • Error handling best practices

Example Comparison:

// Filter - Dataset advanced query
const result = await client.models.users.filter({
where: { status: { $eq: 'active' } },
select: ['id', 'name'],
currentPage: 1,
pageSize: 20,
});

// SQL - Custom query
const data = await client.sql.execute({
sqlCode: 'fc8e7777-06e3847d',
params: { userId: '123' }
});

// BFF - Backend function call
const result = await client.bff.execute({
scriptName: 'getUserDashboard',
params: { userId: '123' }
});

2. MCP SQL Creation Workflow

Master the 5-step process for creating custom SQL.

Process Steps:

  1. Use MCP to get dataset information
  2. Determine query requirements and fields
  3. Create custom SQL on the platform
  4. Call using SDK executeSql()
  5. Handle results and errors

3. AntD UI Development Specifications

Unified AntD component usage style, avoiding "AI flavor".

Specification Content:

  • Component selection principles
  • Style conventions
  • Table configuration specifications
  • Form layout specifications

4. API Integration Guide

Use lovrabet api pull to integrate dataset APIs.

Process Description:

  • Initialize project configuration
  • Pull API configuration
  • Generate API documentation
  • Use in code

5. Menu Management Guide

Use lovrabet menu sync/update to manage menus.

Process Description:

  • Develop new pages
  • Sync menus to platform
  • Update CDN resources

6. Backend Function Script Writing Specifications

Specifications for writing backend function scripts.

Specification Content:

  • Permission filtering
  • Data desensitization
  • Business logic encapsulation
  • Error handling

View Installed Skills

# View manifest
cat .lovrabet/skill-manifest.json

# View guides directory
ls .lovrabet/skill/.shared/guides/

# Read specific guide
cat .lovrabet/skill/.shared/guides/01-typescript-sdk/guide.md

Update Skills

Skills are updated with CLI versions. To update to the latest version:

# Reinstall
lovrabet skill install --cursor

# CLI will overwrite existing files and update to the latest version

Use with MCP

Skills work better when combined with MCP:

# 1. Install skills
lovrabet skill install --cursor

# 2. Configure MCP
lovrabet mcp install cursor

Combined Effect:

  • MCP allows AI to access dataset information
  • Skills teach AI how to correctly use SDK
  • Together, AI can generate more accurate code

Troubleshooting

Issue: Skill Files Not Taking Effect

Checklist:

  1. Confirm files are created
  2. Restart IDE
  3. Check if IDE supports this format of rule files

Solution:

# Check if files exist
ls -la .cursorrules
ls -la .lovrabet/skill/.shared/guides/

# Reinstall
lovrabet skill install --cursor

Issue: IDE Does Not Recognize Rule Files

Different IDEs have different support for rule files:

  • Cursor: Supports .cursorrules and .cursor/skills/
  • Windsurf: Supports .windsurf/workflows/
  • Claude Code: Supports .claude/skills/ and agents.md

If IDE does not recognize, please check IDE version and documentation.