easytwin-cli

CLI 命令

init - 初始化项目

创建一个新的 EasyTwin 组件开发项目。

pnpm easytwin-cli init <project-name>

示例：

pnpm easytwin-cli init my-components
cd my-components
pnpm install

该命令会创建一个基于 pnpm 的 monorepo 仓库，包含：

my-components/
├── packages/              # 组件包目录
├── package.json           # 项目配置（已包含 @easytwin/runtime、@easytwin/runtime-frontend、@easytwin/cli）
├── pnpm-workspace.yaml    # workspace 配置
├── tsconfig.base.json     # TypeScript 基础配置
├── eslint.config.js       # ESLint 配置
├── jest.config.ts         # Jest 测试配置
└── .gitignore

create - 创建组件包

在当前项目的 packages/ 目录下创建组件包。

pnpm easytwin-cli create <component-type> [-t template] [-u url]

参数说明：

| 参数 | 说明 | 默认值 | | ------------------ | ------------------------------------------------------- | ------------------------ | | <component-type> | 组件类型名（如 thermometer、alarm-panel） | 必填 | | -t, --template | 模板类型：example（简单组件）或 digital（数字要素） | example | | -u, --url | 后端接口地址 | http://twin.easyv.test |

示例：

# 创建简单组件
pnpm easytwin-cli create thermometer

# 创建数字要素组件（支持子要素）
pnpm easytwin-cli create alarm-panel -t digital

命名转换：

| 输入 | 组件包目录 | 类名 | | ------------- | --------------------------------- | ---------------------- | | thermometer | easytwin-components-thermometer | ThermometerComponent | | alarm-panel | easytwin-components-alarm-panel | AlarmPanelComponent |

upload - 上传组件

将构建好的组件上传到指定环境。

pnpm easytwin-cli upload [options]

参数说明：

| 参数 | 说明 | | ------------------ | -------------------------------------- | | -l, --local | 上传到本地 bundled/ 目录 | | -f, --force | 强制覆盖已存在的同版本组件 | | -m, --mode <env> | 环境选择：dev、test、pre、prod | | --message <text> | 版本更新说明 |

示例：

# 上传到本地（开发调试）
pnpm easytwin-cli upload -l

# 上传到开发环境
pnpm build && pnpm easytwin-cli upload -f --mode dev --message "新增温度显示功能"

# 上传到生产环境
pnpm build && pnpm easytwin-cli upload --mode prod