@taobao-minigame/cli 0.0.1-beta.1 → 0.0.1-beta.3

package/README.md

@@ -1,39 +1,139 @@
 # @taobao-minigame/cli
 
+淘宝开放平台 CI/CD 命令行工具，支持小程序、小游戏、小部件等应用的预览与上传发布。安装后提供 `tbgame` 命令。
 
+## 安装
 
-## Installation
+```bash
+npm install -g @taobao-minigame/cli
+```
+
+安装完成后验证：
+
+```bash
+tbgame -v
+tbgame -h
+```
+
+## 快速开始
+
+```bash
+# 1. 登录淘宝账号（会拉起 Chrome 完成扫码/账号登录）
+tbgame login
+
+# 2. 在项目根目录生成预览二维码
+tbgame preview --appId <appId> --type minigame
+
+# 3. 上传发布版本
+tbgame upload --appId <appId> --type minigame --version 1.0.0
+```
+
+## 命令
+
+### tbgame login
+
+获取淘宝登录态。会通过本地 Chrome 打开登录页，登录成功后凭证保存在本地，供后续命令使用。
+
+如需指定 Chrome 可执行文件路径：
+
+```bash
+tbgame config set PUPPETEER_PATH /path/to/chrome
+```
 
-Install my-project with npm
+### tbgame preview
+
+生成预览链接/二维码。
+
+```bash
+tbgame preview [options]
+```
+
+| 参数 | 说明 | 默认值 |
+| --- | --- | --- |
+| `-i, --input <input>` | 应用根目录（`mini.project.json` 或 `app.json`/`package.json` 所在目录） | 当前目录 |
+| `-a, --appId <appId>` | 指定应用 appId | - |
+| `-t, --type <open_type>` | 应用类型，见下方[应用类型](#应用类型) | - |
+| `-d, --debug` | 开启真机调试 | `false` |
+| `-c, --cloud` | 开启云构建 | `false` |
+| `--pagePath <pagePath>` | 指定访问首页 | - |
+| `--pageQuery <pageQuery>` | 页面参数，如 `"a=1&b=2"` | - |
+| `--query <query>` | 全局 query | - |
+| `--copy` | 复制预览码到剪贴板 | `false` |
+| `--renderMode <mode>` | 小游戏渲染模式：`highPerformance` \| `normal` | `highPerformance` |
+| `--noBuild` | 跳过云构建，使用本地缓存的上一次构建结果生成二维码（无缓存时报错） | `false` |
+| `--autoOpenDevtools` | 真机调试拿到 DevTools 地址后自动用本地 Chrome 打开（路径取 `PUPPETEER_PATH` 配置，无则用系统默认 Chrome） | `false` |
+
+示例：
 
 ```bash
-  npm install my-project
-  cd my-project
+# 小游戏预览（云构建）
+tbgame preview -a 1234567 -t minigame -c
+
+# 真机调试并自动打开 DevTools
+tbgame preview -a 1234567 -t minigame -d --autoOpenDevtools
 ```
-    
-## Environment Variables
 
-To run this project, you will need to add the following environment variables to your .env file
+### tbgame upload
 
-`API_KEY`
+上传发布应用。
 
-`ANOTHER_API_KEY`
+```bash
+tbgame upload [options]
+```
 
+| 参数 | 说明 | 默认值 |
+| --- | --- | --- |
+| `-i, --input <input>` | 应用根目录 | 当前目录 |
+| `-a, --appId <appId>` | 指定应用 appId | - |
+| `-t, --type <open_type>` | 应用类型，见下方[应用类型](#应用类型) | - |
+| `-v, --version <version>` | 指定上传的应用版本号 | - |
+| `--renderMode <mode>` | （小游戏）渲染模式：`highPerformance` \| `normal` | `highPerformance` |
 
-## Documentation
+示例：
 
-[Documentation](https://<your documentation link>)
+```bash
+tbgame upload -a 1234567 -t minigame -v 1.0.0
+```
 
+### tbgame app
+
+获取开放平台应用的基础信息（应用名称、最新线上版本）。
+
+```bash
+tbgame app --appId <appId>
+```
+
+### tbgame config
+
+管理工具本地配置。
+
+```bash
+tbgame config set <key> <value>   # 设置
+tbgame config get <key>           # 读取
+tbgame config show                # 查看全部配置
+```
 
-## Authors
+常用配置项：
 
-- [@<you>](<how ot contact you>)
+| key | 说明 |
+| --- | --- |
+| `PUPPETEER_PATH` | 本地 Chrome 可执行文件路径，`login` 与 `--autoOpenDevtools` 使用 |
 
+## 应用类型
 
-## Contributing
+`--type` 参数取值：
 
-Contributions are always welcome!
+| 应用类型 | type 取值 |
+| --- | --- |
+| 小程序 | `miniapp` |
+| 小部件 | `widget` |
+| 小游戏 | `minigame` |
+| 标准化应用 | `standardizedApp` |
+| 商家后台应用 | `isvCMS` |
+| 配置应用 | `webapp` |
 
-See `contributing.md` for ways to get started.
+## 常见问题
 
-Please adhere to this project's `code of conduct`.
+- **提示"当前路径没有绑定 appId"**：通过 `-a, --appId` 显式指定。
+- **命令执行报错想看详细日志**：在命令上追加 `--showProcess` 查看完整执行过程日志。
+- **登录失败或无法拉起浏览器**：先通过 `tbgame config set PUPPETEER_PATH <chrome路径>` 指定本地 Chrome。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@taobao-minigame/cli",
-  "version": "0.0.1-beta.1",
+  "version": "0.0.1-beta.3",
   "description": "淘宝开放 CI、CD命令行工具",
   "keywords": [
     "ci",