Skip to content

TIP

这篇文档说明如何用 rabetbase 在本地创建一个 Lovrabet 项目工程。创建完成后,你会得到一个可启动的前端项目,并生成 .rabetbase.json 配置文件。 已有工程只需要补配置时,使用 rabetbase project init

准备工作

开始前确认三件事:

准备项操作
已安装 Rabetbase CLI执行 rabetbase --version,能看到版本号即可
已登录 Lovrabet执行 rabetbase auth login
已确定项目目录在终端进入你希望放置项目的上级目录

如果你已经有要绑定的 Lovrabet 应用,准备好对应的 App Code。如果还没有,也可以先跳过,项目创建后再配置。


方式一:在 Claude Code 中创建

在 Claude Code 里,可以直接描述你要创建的项目,让 Agent 执行 rabetbase 并检查结果。

复制下面的 prompt,把项目名和 App Code 改成自己的:

text
请在当前目录用 rabetbase 创建一个本地项目工程。

项目名:<项目名>
App Code:<APP_CODE>

创建完成后,请检查:
1. 项目目录是否创建成功
2. `.rabetbase.json` 是否存在
3. `package.json` 的 name 是否已改成项目名
4. 如果依赖没有安装,请进入项目目录执行 `npm install`
5. 最后告诉我启动命令

Agent 通常会完成这些动作:

  1. 检查 rabetbase 是否可用。
  2. 执行项目创建命令。
  3. 检查项目目录、.rabetbase.jsonpackage.json
  4. 如有需要,补执行依赖安装。
  5. 给出启动命令。

方式二:在终端手动创建

如果你第一次使用,建议直接运行交互式向导:

bash
rabetbase project create
🎬 视频准备中:rabetbase-cli-project-create.mp4

按提示完成下面几步:

  1. 输入项目名,例如 my-sales-app
  2. 选择要绑定的应用。
  3. 如果列表里没有应用,选择手动输入 App Code
  4. 如果暂时不绑定应用,选择跳过。
  5. 等待 CLI 完成创建、安装依赖、格式化代码和写入配置。

WARNING

项目名只能使用字母、数字、-_,并且不能和当前目录下已有文件夹重名。

已知道项目名和 App Code

如果项目名和 App Code 都已经确定,可以直接执行:

bash
rabetbase project create <项目> --appcode <APP_CODE>

也可以用 --name 写法:

bash
rabetbase project create --name <项目> --appcode <APP_CODE>

没有传 --appcode 时,CLI 会进入应用选择流程;没有应用时可以手动输入,也可以跳过。


创建过程会生成什么

动作结果
复制项目模板在当前目录下生成 <项目名>/
更新 package.jsonname 会改成项目名
安装依赖交互式创建时会执行依赖安装
格式化代码执行代码格式化
写入 .rabetbase.json保存环境、应用绑定和创建时间
拉取 API 配置绑定 App Code 时会尝试生成 src/api/

如果 API 配置拉取失败,项目目录仍会保留。进入项目目录后重新执行:

bash
rabetbase api pull

启动项目

创建完成后,进入项目目录并启动:

bash
cd <项目>
rabetbase run start

启动成功后,终端会显示本地访问地址。打开地址即可查看本地项目页面。

检查结果

  • [ ] 当前目录下有 <项目名>/ 文件夹。

  • [ ] <项目名>/.rabetbase.json 存在。

  • [ ] <项目名>/package.jsonname 是你的项目名。

  • [ ] 绑定 App Code 时,.rabetbase.json 里有 appsdefaultApp

  • [ ] 启动命令 rabetbase run start 能正常运行。


常见问题

提示需要登录怎么办?

先执行:

bash
rabetbase auth login

登录完成后重新创建项目。

项目目录已经存在怎么办?

换一个项目名,或进入另一个上级目录后重新执行。

创建时跳过了 App Code,后面怎么补?

进入项目目录后配置 App Code,再拉取 API 配置:

bash
cd <项目>
rabetbase config set --key appcode --value <APP_CODE>
rabetbase api pull

在 CI 或无交互环境中创建有什么区别?

无交互环境必须直接提供项目名,建议同时提供 App Code:

bash
rabetbase project create <项目> --appcode <APP_CODE> --non-interactive

无交互创建会跳过依赖安装。创建完成后进入项目目录执行:

bash
npm install

基于飞书知识库同步生成,内容以飞书源文档为准