@lovrabet/rabetbase-cli 2.3.4-beta.1 → 2.3.4-beta.2

package/README.md

@@ -1,627 +1,166 @@
-# Rabetbase CLI（`@lovrabet/rabetbase-cli`）
+# Rabetbase CLI
 
-一个强大的前端开发脚手架工具，专为 [Lovrabet](https://www.lovrabet.com) 开放平台应用开发而设计。提供项目创建、页面生成、API 集成、开发调试等全套开发工具链。全局安装后的默认可执行文件名为 **`rabetbase`**（仍提供 **`lovrabet`** 作为兼容别名）。
+Rabetbase CLI is the developer command-line interface for Lovrabet
+applications. It helps developers, delivery teams, and AI agents create
+projects, bind workspaces, inspect developer-side app contracts, manage
+datasets, generate API files, synchronize smart list pages, publish SQL and BFF
+assets, manage database connections, and prepare agent-ready development
+workflows from a stable terminal surface.
 
-## ✨ 特性
+The CLI is designed for development-time operations. Use it to configure and
+publish Lovrabet app assets before they become runtime capabilities. For
+runtime business data queries, runtime SQL or BFF execution, and app-specific
+business Skills, use the Lovrabet runtime CLI (`@lovrabet/lovrabet-cli`).
 
-- 🚀 **快速创建项目** - 基于模板快速生成完整的前端应用项目
-- 📄 **智能页面生成** - 自动生成页面组件和路由配置
-- 🔐 **统一身份认证** - 集成 Lovrabet 平台登录和权限管理
-- 🌐 **API 自动生成** - 根据数据集自动生成 API 配置文件
-- 📋 **菜单智能同步** - 自动扫描本地页面并同步菜单到平台，支持多种命名策略
-- ⚡ **开发服务器** - 内置热更新开发服务器
-- 🏗️ **智能构建** - 优化的生产环境构建配置
-- 📦 **模板管理** - 丰富的项目模板和组件模板
-- 📝 **日志管理** - 完整的开发日志记录和查看
+## Requirements
 
-## 📦 安装
+- Node.js 20 or later
+- A Lovrabet account with access to the target developer app
+- Browser login for commands that call the Lovrabet platform
+- An existing Lovrabet frontend project, or a new project created by this CLI
 
-### 全局安装（推荐）
-
-```bash
-# 使用 npm
-npm install -g @lovrabet/rabetbase-cli
-
-# 使用 bun（推荐）
-bun install -g @lovrabet/rabetbase-cli
-```
-
-### 验证安装
+## Install
 
 ```bash
+npm install -g @lovrabet/rabetbase-cli@latest
+rabetbase --version
 rabetbase --help
 ```
 
-## 🚀 快速上手
-
-### 1. 登录认证
-
-首先需要登录 Lovrabet 平台获取访问权限：
-
-```bash
-rabetbase auth
-```
-
-这会打开浏览器登录页面，完成登录后 CLI 会自动保存认证信息。
-
-### 2. 创建项目
-
-```bash
-rabetbase create
-```
-
-CLI 会引导您选择项目模板并创建完整的项目结构。
-
-### 3. 启动开发
-
-进入项目目录并启动开发服务器：
-
-```bash
-cd your-project
-rabetbase start
-```
-
-### 4. 生成 API 配置[可选]
-
-如果在create的时候未选择自动更新API列表，或者API已经发生变化，可以手动根据应用的appcode自动生成 API 配置：
+You can also run a specific version with npm tooling:
 
 ```bash
-rabetbase api pull --appcode <app-code>
+npx @lovrabet/rabetbase-cli@latest --help
 ```
 
-### 5. 添加页面
-
-在项目中快速添加新页面：
-
-```bash
-rabetbase add page
-```
-
-## 🤖 Agent Runtime 智能发布
-
-在支持仓库 Agent Skill 的 Agent Runtime terminal 中，可以输入发布意图。Agent 会加载并遵循本仓 repo-local deploy skill：`.agents/skills/flow-rabetbase-cli-deploy/SKILL.md`，该 skill 会引用 `wiki/policies/cli-deploy-policy.md`，并最终调用受保护的 npm 发布脚本：
-
-| 输入 | Agent 执行动作 |
-| --- | --- |
-| `deploy beta` | 按 `flow-rabetbase-cli-deploy` 的 beta 流程执行门禁，临时写 beta 版本并发布 npm beta；不创建 MR、不把 beta 版本提交回 `main` |
-| `deploy latest` | 按 `flow-rabetbase-cli-deploy` 的 latest 流程执行门禁，临时写 stable 版本并发布 npm latest / Open Skill；不创建 MR、不把 latest 版本提交回 `main` |
-
-`deploy beta` / `deploy latest` 是 Agent 意图短语，不是普通 shell 命令；也不是直接在 shell 中执行 `SKILL.md` 文件。普通终端中请直接使用 `npm run beta-release` 或 `npm run release`。裸 `deploy` 不作为推荐发布入口；Agent 收到时应先要求用户明确 `beta` 或 `latest` 通道，不能默认执行正式发布。
-
-发布硬规则：
-
-- `deploy beta` / `deploy latest` 不要求 MR，也不写 `main`；可在干净的 `main` 或 release 工作区执行，但脚本不得提交或推送当前分支。
-- 修改代码、文档、Skill、脚本、测试等仓库持久化内容必须走 CodeUp MR。
-- 发布前必须完成本地验证，并确认当前 npmjs 发布身份。
-- npm 发布认证以 npm CLI 提供的 WebAuthn / Security Key 链路为主；OTP 仅在 npm CLI 明确要求时作为兜底。
-
-## 分场景使用教程
-
-由浅入深的说明见 **[docs/user-guide/README.md](./docs/user-guide/README.md)**（安装与登录、配置与多应用、API/数据集、自定义 SQL、BFF 同步、代码生成与菜单、排障等）。逐项参数仍以 [docs/commands.md](./docs/commands.md) 为准。
-
-## 📚 命令详解
-
-### 项目管理
-
-#### `rabetbase create [项目名]`
-
-创建新的前端应用项目
-
-- **功能**: 基于预设模板创建完整的项目结构
-- **模板类型**:
-  - React 单页应用
-  - 多页面应用
-  - 组件库项目
-- **自动配置**: 路由、状态管理、API 集成、构建配置
-
-#### `rabetbase add page`
-
-添加新页面到当前项目
-
-- **功能**: 自动生成页面组件、样式文件和路由配置
-- **支持**: 嵌套路由、动态路由、页面模板选择
-- **自动更新**: 路由配置文件和导航菜单
-
-### 开发调试
-
-#### `rabetbase start`
+## Quick Start
 
-启动开发服务器
-
-- **热更新**: 文件变化自动刷新
-- **代理配置**: 自动配置 API 代理
-- **错误提示**: 友好的错误信息和调试提示
-
-#### `rabetbase build`
-
-构建生产版本
-
-- **代码压缩**: 自动压缩 JS、CSS、HTML
-- **资源优化**: 图片压缩、字体子集化
-- **缓存优化**: 文件名哈希、分包策略
-
-#### `rabetbase preview [--watch]`
-
-预览构建结果
-
-- **本地服务**: 启动本地预览服务器
-- **监听模式**: `--watch` 参数自动重新构建
-
-### API 集成
-
-#### `rabetbase api pull`
-
-拉取并生成 API 配置文件
-
-- **自动发现**: 扫描应用数据集和接口
-- **类型生成**: 自动生成 TypeScript 类型定义
-- **配置生成**: 生成 SDK 配置文件
-- **可用参数**: `--appcode`、`--output`、`--env`（v1.1.7+）
-
-### 身份认证
-
-#### `rabetbase auth`
-
-登录 Lovrabet 平台
-
-- **浏览器登录**: 打开浏览器进行 OAuth 登录
-- **令牌管理**: 自动保存和刷新访问令牌
-- **权限验证**: 验证项目访问权限
-
-#### `rabetbase logout`
-
-退出登录
-
-- **清理令牌**: 清除本地保存的认证信息
-- **安全退出**: 通知服务器撤销令牌
-
-### 菜单管理
-
-#### `rabetbase menu sync`
-
-同步本地页面到 Lovrabet 平台菜单
+Authenticate first:
 
 ```bash
-rabetbase menu sync
+rabetbase auth login
 ```
 
-- **自动扫描**: 扫描 `src/pages` 目录下的所有页面
-- **智能对比**: 对比本地和平台菜单，找出缺失项
-- **智能命名**: 支持多种菜单名称提取策略（详见文档）
-- **批量创建**: 一键创建所有缺失的菜单项
-
-**菜单名称提取优先级**：
-
-1. **Title 注释**（最高优先级）- 在文件顶部注释中添加 `Title: 菜单名称`
-2. **displayName 属性** - 组件的 `displayName` 属性
-3. **组件名** - `export default` 的组件名（PascalCase）
-4. **文件路径**（兜底）- 使用相对路径作为菜单名
-
-> 💡 **推荐做法**：使用 `Title:` 注释，可以设置中文菜单名，更加清晰易懂。
-
-### 配置管理
-
-#### `rabetbase init`
-
-在现有项目中初始化 Lovrabet 配置文件（v1.1.12+）
+Create a new Lovrabet frontend project:
 
 ```bash
-rabetbase init                           # 交互式初始化
-rabetbase init --appcode my-app-code     # 直接指定 appcode
-rabetbase init --appcode my-app --env daily  # 指定环境
+rabetbase project create my-app
+cd my-app
 ```
 
-- **交互式输入**: 支持交互式输入 appcode，带实时格式验证
-- **智能验证**: 自动验证 appcode 格式（字母、数字、- 和 \_）
-- **安全保护**: 检测并防止覆盖现有配置文件
-- **配置继承**: 自动继承全局配置（如环境设置）
-- **版本记录**: 生成的配置包含创建时间和 CLI 版本
-
-**使用场景**：为已有的前端项目添加 Lovrabet 支持，无需重新创建项目。
-
-#### `rabetbase config`
-
-项目配置管理
-
-- **应用绑定**: 绑定 Lovrabet 应用
-- **环境配置**: 开发/生产环境切换
-- **API 配置**: 数据集和接口配置
-
-### 日志管理
-
-#### `rabetbase logs`
-
-查看开发日志
+Initialize or update the current workspace app binding:
 
 ```bash
-rabetbase logs          # 查看最新日志
-rabetbase logs --clear  # 清空日志记录
+rabetbase workspace init --appcode <app-code>
+rabetbase doctor
 ```
 
-## 🏗️ 项目结构
-
-CLI 创建的项目具有以下标准结构：
-
-```
-your-project/
-├── src/
-│   ├── components/     # 公共组件
-│   ├── pages/         # 页面组件
-│   ├── layouts/       # 布局组件
-│   ├── api/          # API 配置
-│   ├── utils/        # 工具函数
-│   ├── router/       # 路由配置
-│   └── main.tsx      # 入口文件
-├── public/           # 静态资源
-├── docs/            # 项目文档
-├── package.json     # 项目配置
-├── vite.config.ts   # 构建配置
-├── tsconfig.json    # TypeScript 配置
-└── .rabetbase.json  # Rabetbase CLI 配置
-```
-
-## ⚙️ 配置文件
-
-### `.rabetbase.json`
-
-项目根目录的配置文件（JSON 格式），用于配置应用基本信息：
-
-```json
-{
-  "appcode": "your-app-code",
-  "env": "production",
-  "createdAt": "2025/1/5 10:30:00",
-  "version": "1.1.15"
-}
-```
-
-**配置说明：**
-
-| 字段 | 说明 | 可选值 |
-|------|------|--------|
-| `appcode` | 应用代码，用于标识您的应用 | 字母、数字、`-` 和 `_` |
-| `env` | 运行环境 | `"production"` 或 `"daily"` |
-| `createdAt` | 配置创建时间（自动生成） | - |
-| `version` | CLI 版本（自动生成） | - |
-
-**生成方式：**
+Pull developer-side dataset contracts and generate local API files:
 
 ```bash
-# 通过 init 命令生成
-rabetbase init --appcode your-app-code
-
-# 或通过 create 命令自动生成
-rabetbase create
-```
-
-> 💡 **注意**：`.rabetbase.json` 是 CLI 工具的配置文件（兼容旧名 `.lovrabet.json` / `.lovrabetrc`）。SDK 的 API 配置（models）由 `rabetbase api pull` 命令自动生成到 `src/api/` 目录。
-
-## 🔧 环境要求
-
-- **Node.js**: >= 20.0.0
-- **包管理器**: npm、yarn 或 bun
-- **浏览器**: Chrome、Firefox、Safari、Edge 等现代浏览器
-
-## 🎯 使用场景
-
-### 快速原型开发
-
-```bash
-rabetbase create prototype-app
-cd prototype-app
-rabetbase api pull --appcode your-app-code
-rabetbase start
-```
-
-### 为现有项目添加 Lovrabet 支持（v1.1.12+）
-
-```bash
-# 进入现有项目目录
-cd existing-project
-
-# 初始化 Lovrabet 配置
-rabetbase init --appcode your-app-code
-
-# 拉取 API 配置
-rabetbase api pull
-
-# 生成 API 文档
-rabetbase api doc
-```
-
-### 企业级应用开发
-
-```bash
-rabetbase create enterprise-app
-cd enterprise-app
-rabetbase config  # 配置生产环境
-rabetbase add page  # 添加业务页面
-rabetbase build     # 构建生产版本
+rabetbase api pull --appcode <app-code>
 ```
 
-### 组件库开发
+Inspect a dataset before changing its structure or generated assets:
 
 ```bash
-rabetbase create component-library
-cd component-library
-# 开发和测试组件...
-rabetbase build
+rabetbase dataset list --name customer --format pretty
+rabetbase dataset detail --code <dataset-code> --format compress
+rabetbase dataset operations --code <dataset-code> --format compress
 ```
 
-## 🆘 故障排查
+Use `--format pretty` for human-readable output and `--format json` or
+`--format compress` for scripts and agents.
 
-### 常见问题
+## AI Agent Skill
 
-**Q: 登录失败或权限不足？**
-A: 确保您有 Lovrabet 平台的访问权限，尝试重新登录：
+If your coding environment supports the `skills` CLI, install the Rabetbase CLI
+Built-in Skill so the agent can follow the correct app resolution, dataset
+inspection, page, SQL, BFF, and risk-control workflow:
 
 ```bash
-rabetbase logout
-rabetbase auth
+rabetbase cli-skill install
 ```
 
-**Q: API 拉取失败？**
-A: 检查应用代码是否正确，确认您有该应用的访问权限：
+Equivalent direct installation:
 
 ```bash
-rabetbase api pull --appcode correct-app-code
+npx skills add lovrabet/rabetbase -g -y
 ```
 
-**Q: 构建错误？**
-A: 查看详细错误信息：
+Runtime business Skills are installed with the Lovrabet runtime CLI after
+selecting the target runtime app:
 
 ```bash
-rabetbase logs
+lovrabet skill install
 ```
 
-**Q: 开发服务器启动失败？**
-A: 检查端口是否被占用，或指定其他端口。
-
-### 日志和调试
-
-查看详细的操作日志：
-
-```bash
-rabetbase logs
-```
-
-清空日志记录：
-
-```bash
-rabetbase logs --clear
-```
-
-## 📝 What's New
-
-### v1.1.15 (2025-01-05)
-
-**新增功能 (New Features):**
-
-- ✨ **菜单同步智能标题提取** - `rabetbase menu sync` 命令一键将二开应用工程自动同步到Lovrabet生成的业务系统，瞬间完成主子应用合并，无需执行繁琐的手动配置。
-  **核心特性：**
-  - 🎯 **支持中文菜单名** - 使用 Title 注释可以直接写中文，用户体验更友好
-  - 📋 **优先级清晰** - Title > displayName > 组件名 > 文件路径
-  - 🔧 **灵活配置** - 支持多种命名策略，满足不同团队习惯
-  - ✅ **自动回退** - 即使没有设置，也能自动使用文件路径作为兜底
-  - 🛡️ **格式容错** - Title 支持大小写、单双星号注释等多种格式
-
-详情点击此处 [rabetbase menu sync](https://open.lovrabet.com/docs/lovrabet-cli/menu-sync)
-
----
-
-### v1.1.12 (2025-10-17)
-
-**新增功能 (New Features):**
-
-- ✨ **新增 `rabetbase init` 命令** - 在现有项目中快速初始化配置
-
-  为已有项目添加 Lovrabet 配置支持：
-
-  ```bash
-  # 交互式初始化
-  rabetbase init
-
-  # 直接指定 appcode
-  rabetbase init --appcode my-app-code
-
-  # 指定环境
-  rabetbase init --appcode my-app-code --env daily
-  ```
-
-  - 🔍 智能验证 appcode 格式（只允许字母、数字、- 和 \_）
-  - 🛡️ 自动检测并防止覆盖现有配置文件
-  - 🔄 继承全局配置，无需重复设置
-  - 📝 配置文件包含创建时间和 CLI 版本信息
-  - 💬 友好的交互式输入体验
-
-- ✨ **`rabetbase api doc` 增强** - 支持按需生成和自定义参数
-
-  ```bash
-  # 只生成指定数据集的文档
-  rabetbase api doc --datasetcode ds_001
-
-  # 生成多个指定数据集的文档（用逗号分隔）
-  rabetbase api doc --datasetcode ds_001,ds_002,ds_003
-
-  # 传递额外参数到文档生成 API
-  rabetbase api doc --params '{"customField": "value"}'
-  ```
+## Common Commands
 
-  - 🎯 **按需生成文档** - 通过 `--datasetcode` 参数指定要生成的数据集
-  - ✅ **智能验证** - 自动检查指定的数据集代码是否存在
-  - 📊 **统计反馈** - 显示匹配的数据集数量和无效的代码
-  - 🔧 **自定义参数** - 支持通过 JSON 格式传递额外参数
-
-**改进优化 (Improvements):**
-
-- 📊 **优化文件命名策略** - 提高文件名唯一性
-  - 短代码从 4 位扩展到 6 位
-  - 减少文件名冲突的可能性
-
-**使用场景：**
-
-```bash
-# 场景1: 为现有项目添加 Lovrabet 支持
-cd existing-project
-rabetbase init --appcode my-app
-rabetbase api pull
-
-# 场景2: 只生成指定数据集的文档
-rabetbase api doc --datasetcode dataset_abc123
-
-# 场景3: 批量生成多个数据集的文档
-rabetbase api doc --datasetcode dataset_abc123,dataset_def456,dataset_ghi789
-```
-
----
-
-### v1.1.11 (2025-10-16)
-
-**新增功能 (New Features):**
-
-- ✨ **API 文档自动生成** - 全新的文档生成工具，让 API 使用更清晰
-
-  现在可以一键生成所有数据集的 API 使用文档（Markdown 格式）：
-
-  ```bash
-  rabetbase api doc
-  ```
-
-  - 📚 自动生成完整的 API 使用说明
-  - 📊 包含数据字段、请求示例、响应格式等
-  - 🎯 支持批量生成，自动处理所有数据集
-  - 📁 输出为标准 Markdown 格式，便于团队共享
-
-**改进优化 (Improvements):**
-
-- 📦 **升级项目模板 SDK** - 提升开发体验和类型安全
-  - 项目模板中的 `@lovrabet/sdk` 升级至 v1.1.16
-  - 新增 `SortOrder` 类型支持，提供更好的类型提示
-  - 优化代码规范和格式，提升生成代码质量
-
-- 🔧 **数据集智能去重** - API 拉取更精准
-  - 自动识别并过滤重复的数据集（相同 `tableName`）
-  - 显示详细的去重统计信息
-  - 避免配置文件中出现重复项
-
-- 🎨 **SDK 数据获取页面模板优化** - 生成的页面更简洁高效
-  - 精简 UI 组件代码，提升可维护性
-  - 增强表格数据处理能力
-  - 改进数据展示性能
-  - 优化代码结构和注释
-
-- 🎯 **API 配置管理优化**
-  - 优化用户交互提示信息
-  - 改进错误处理和提示
-  - 提升整体用户体验
+| Area | Commands |
+| --- | --- |
+| Authentication | `rabetbase auth login`, `rabetbase auth logout` |
+| Project and workspace | `rabetbase project create`, `rabetbase project init`, `rabetbase project upgrade`, `rabetbase workspace init`, `rabetbase workspace use` |
+| App profiles | `rabetbase app list`, `rabetbase app add`, `rabetbase app remove` |
+| Dataset contracts | `rabetbase dataset list`, `rabetbase dataset detail`, `rabetbase dataset operations`, `rabetbase dataset relations`, `rabetbase dataset relation-audit` |
+| Dataset changes | `rabetbase dataset generate-start`, `rabetbase dataset generate-status`, `rabetbase dataset field-update`, `rabetbase dataset extend-update`, `rabetbase dataset business-group-update` |
+| API generation | `rabetbase api list`, `rabetbase api pull`, `rabetbase api generate`, `rabetbase codegen sdk`, `rabetbase codegen sql` |
+| Smart list pages | `rabetbase page generate-start`, `rabetbase page generate-status`, `rabetbase page pull`, `rabetbase page push`, `rabetbase page sync`, `rabetbase page relation-audit` |
+| SQL and BFF assets | `rabetbase sql list`, `rabetbase sql detail`, `rabetbase sql create`, `rabetbase sql push`, `rabetbase sql validate`, `rabetbase bff list`, `rabetbase bff detail`, `rabetbase bff push` |
+| Database connections | `rabetbase db list`, `rabetbase db detail`, `rabetbase db create`, `rabetbase db test`, `rabetbase db analyze-start`, `rabetbase db analyze-status` |
+| Menu and app config | `rabetbase menu list`, `rabetbase menu sync`, `rabetbase menu update`, `rabetbase app-config list`, `rabetbase app-config get`, `rabetbase app-config set` |
+| Diagnostics | `rabetbase doctor`, `rabetbase schema`, `rabetbase logs show`, `rabetbase update` |
 
-**使用示例：**
+Run command-level help for flags and prerequisites:
 
 ```bash
-# 创建新项目（自动使用最新模板）
-rabetbase create my-app
-
-# 生成 API 配置文件
-rabetbase api pull --appcode my-app
-
-# 生成 API 文档（新功能）
-rabetbase api doc
-
-# 查看详细日志
-rabetbase logs
+rabetbase <service> --help
+rabetbase <service> <command> --help
 ```
 
----
-
-### v1.1.7 (2025-10-10)
-
-**重大变更 (Breaking Changes):**
-
-- 🔴 **`rabetbase api pull` 命令参数调整**
-  - ❌ **不再支持**位置参数方式（如 `rabetbase api pull my-app-code`）
-  - ✅ **改用** `--appcode` 参数（如 `rabetbase api pull --appcode my-app-code`）
-  - 迁移指南：将 `rabetbase api pull <app-code>` 改为 `rabetbase api pull --appcode <app-code>`
-
-**新增功能 (New Features):**
-
-- ✨ **新增 `--output` 参数** - 支持自定义 API 文件输出目录
-  ```bash
-  rabetbase api pull --output ./lib/api
-  ```
-- ✨ **新增 `--env` 参数** - 支持指定环境拉取 API（内部使用）
-  ```bash
-  rabetbase api pull --env <env>
-  ```
+## Output and Automation
 
-**改进 (Improvements):**
-
-- 📚 优化命令行帮助信息，参数说明更加清晰
-- 🔧 统一命令行参数风格，所有参数均使用 `--` 前缀
-- 📖 更新文档，添加版本标识和迁移说明
-
-**使用示例：**
+Global options are available across commands:
 
 ```bash
-# ✅ 推荐用法
-rabetbase api pull                                  # 使用配置的 appcode
-rabetbase api pull --appcode my-app                 # 指定 appcode
-rabetbase api pull --output ./lib/api               # 自定义输出目录
-rabetbase api pull --appcode my-app --output ./api  # 组合使用
-
-# ❌ 不再支持
-rabetbase api pull my-app  # 位置参数方式已废弃
+rabetbase dataset list --format json
+rabetbase dataset detail --code <dataset-code> --format compress
+rabetbase sql push --sqlcode <sql-code> --dry-run
+rabetbase bff push --type ENDPOINT --name <function-name> --dry-run
 ```
 
----
-
-### v1.1.6 (2025-09-30)
-
-**改进 (Improvements):**
-
-- 📦 **升级模板 SDK** - 项目模板中的 SDK 升级到最新版本，支持更多特性
-
----
-
-### v1.1.4 (2025-09-27)
-
-**重大变更 (Breaking Changes):**
-
-- 🔴 **统一模型配置字段命名** - 重构模型配置字段命名规范（可能影响现有配置）
-  - 请查阅文档更新配置文件中的字段名称
-
----
-
-## 📖 更多资源
-
-- [Lovrabet SDK 使用指南](https://www.npmjs.com/package/@lovrabet/sdk)
-- [示例项目](https://github.com/lovrabet/sub-app-react-demo)
-- [完整文档](https://docs.lovrabet.com)
-
----
-
-## 📎 源码仓库
-
-- Git（阿里云 Codeup）：`git@codeup.aliyun.com:yuntoo/open/rabetbase-cli.git`
-- 从旧仓库 `lovrabet-cli` 迁移后，请更新本地 `remote`：`git remote set-url origin git@codeup.aliyun.com:yuntoo/open/rabetbase-cli.git`
-
-## 🤝 反馈
-
-如遇到问题或有功能建议，欢迎提交 Issue！
+Important options:
 
-## 📄 许可证
+- `--app <name>`: select an app profile by name
+- `--appcode <code>`: override the target app code
+- `--env production|daily`: choose the target environment
+- `--format json|pretty|compress`: choose output format
+- `--jq <expr>`: filter JSON output
+- `--dry-run`: preview supported write operations
+- `--yes`: skip confirmation for high-risk writes
+- `--non-interactive`: force CI-friendly behavior
+- `--global`: write or read global configuration when the command supports it
+- `--project`: restrict configuration reads to the current project when supported
 
-**专有软件（Proprietary）** - 详见 [LICENSE](./LICENSE) 文件
+## Safety Notes
 
-本软件为 Lovrabet 开放平台的专有工具：
+- Inspect developer-side contracts with `dataset detail`, `dataset operations`,
+  or resource-specific `detail` commands before writing changes.
+- Prefer `--dry-run` before SQL, BFF, dataset, page, menu, app-config, or
+  database write operations when supported.
+- Use `--yes` only when the target app, selector, parameters, and impact are
+  already verified.
+- Project-scoped writes are the default for configuration workflows. Use
+  `--global` only when you intentionally want to change global CLI state.
+- Do not commit cookies, access keys, generated credentials, or local user
+  configuration files.
 
-- ✅ **允许使用** - 可以安装和使用本工具开发 Lovrabet 应用
-- ✅ **生成内容归您** - 使用本工具生成的代码和项目归您所有
-- ❌ **不得修改** - 不得修改、反编译或逆向工程
-- ❌ **不得再分发** - 不得复制或分发本软件
-- ❌ **源代码不公开** - 本软件为闭源软件
+## Documentation
 
-如需商业授权或有疑问，请访问 [lovrabet.com](https://www.lovrabet.com)
+- Website: <https://www.lovrabet.com>
+- Developer documentation: <https://open.lovrabet.com/>
+- CLI help: `rabetbase --help`
 
----
+## License
 
-**开始您的 Lovrabet 应用开发之旅！** 🎉
+Licensed under the terms in `LICENSE`.