跳到主要内容

CLI 介绍

欢迎使用 Lovrabet CLI!这是一个专为前端开发者打造的命令行工具,让你可以快速创建项目、生成页面,一键配置开发环境。

简单理解:就像 Vue CLI 或 Create React App 一样,但专门为 Lovrabet 项目定制。

基本信息

  • 安装包名: @lovrabet/cli
  • 命令名称: lovrabet
  • 当前版本: v1.2.0+(重大更新)
  • Node.js 版本: 需要 20 或以上(建议使用最新的 LTS 版本)
  • 支持系统: macOS, Linux, Windows
  • Windows 用户注意: 强烈推荐使用 Git Bash,CMD/PowerShell 仅简单兼容
  • 主要用途: 帮你快速搭建项目、生成页面、连接后端 API

视频教程

快速了解 Lovrabet CLI 的使用方法:

主要功能

🚀 项目管理

  • 创建新项目: 一条命令生成完整的前端项目结构
  • 安装依赖: 自动安装 npm 包,无需手动操作
  • 代码格式化: 自动配置 Prettier,保持代码整洁

📄 页面开发

  • 快速生成页面: 选择模板(空白页面或示例页面),输入路由就能生成页面文件
  • 路由配置: 支持多级路由,比如 user/profile 会创建 src/pages/user/profile/ 目录

🔧 开发工具

  • 本地开发: 一键启动开发服务器(基于 Vite)
  • 项目构建: 打包生产环境代码
  • 预览功能: 本地预览生产版本,支持热更新

🔐 登录认证

  • 一键登录: 打开浏览器完成登录,自动保存登录状态
  • 自动管理: 登录信息保存在本地,下次使用无需重复登录

🌐 API 集成

  • 自动生成: 从后端拉取 API 配置,生成前端调用代码
  • 类型安全: 生成 TypeScript 类型定义,减少出错
  • 客户端封装: 提供统一的 API 调用方式
  • 模型别名 v1.2.0+: 支持配置友好的模型别名

🆕 v1.2.5 新特性

AI 集成能力

MCP 配置 - 让 AI IDE 能够访问 Lovrabet 数据集

lovrabet mcp install --cursor    # 配置 Cursor MCP
lovrabet mcp install --claude # 配置 Claude Code MCP

skill安装 - 为 AI IDE 安装开发规范和指南

lovrabet skill install --cursor    # 安装 Cursor skill
lovrabet skill install --all # 安装所有 IDE skill

支持的 IDE:Cursor、Windsurf、Claude Code、Codex、OpenCode、Qoder、CodeBuddy、Trae

skill包含:

  • Filter 查询构建规范(10 种常见错误对照)
  • MCP SQL 创建工作流(5 步强制流程)
  • AntD UI 开发规范
  • API 集成指南
  • 菜单管理指南

👉 MCP 配置 | skill安装


🆕 v1.2.0 新特性

SDK 版本兼容性检查

启动时自动检查项目中的 @lovrabet/sdk 版本,如果低于 1.2.0 会显示升级提示。

模型配置数组格式

生成的 API 配置以 datasetCode 为核心标识,支持可选的 alias 别名:

// 生成的 api.ts (v1.2.0+)
export const LOVRABET_MODELS_CONFIG = {
appCode: 'my-app',
models: [
{
datasetCode: '8d2dcbae08b54bdd84c00be558ed48df',
tableName: 'users',
alias: 'users', // 可选:模型别名(语法糖)
name: '用户管理',
},
],
} as const;

// 标准方式(推荐)- 全局唯一,AI 友好
const users = client.models.dataset_8d2dcbae08b54bdd84c00be558ed48df.filter();

// 别名方式(语法糖)- 方便人类阅读,功能完全相同
const users = client.models.users.filter();

统一类型定义

新增集中的类型定义模块,改进代码可维护性。

新手入门

如果你是第一次使用,建议按以下顺序阅读:

  1. 安装指南 - 安装 CLI 工具
  2. 快速上手 - 5 分钟创建第一个项目
  3. 命令参考 - 所有可用命令的详细说明

Windows 用户必读

完整文档目录

基础使用

进阶功能

AI 集成 v1.2.5+

工具和帮助