@oppo-minigame/cli/README.md

Command line interface for rapid OPPO minigame development

# `@oppo-minigame/cli`

为开发者提供的打包 OPPO 小游戏的命令行工具, 打包前请查看 [详细教程](https://activity-cdo.heytapimage.com/cdo-activity/static/201810/26/quickgame/documentation/#/games/quickgame)

安装 [@oppo-minigame/cli](https://www.npmjs.com/package/@oppo-minigame/cli) 后，便可使用 `quickgame` 命令。安装方法如下：

> Beta 版本尚在测试中，包含新特性但无法保证稳定性，若遇到问题请重新安装最新正式版本


```bash
npm install -g @oppo-minigame/cli
```

## 使用

```bash
quickgame <command> [env] [-q] [-V] [-d <pub dir>] [--help] 
```

## 参数

### `command`

#### `pack`

打包成标准小游戏工程

#### `subpack`

分包打包

#### `transfer`

微信转 OPPO 小游戏

具体使用细节可参考 [指导文档](https://ie-activity-cn.heytapimage.com/static/minigame/CN/docs/index.html#/develop/games/wx-transfer)

#### `regedit`

注册快捷打包右键菜单项

#### `unregedit`

注销快捷打包右键菜单项

### `env`

打包 RPK 的签名版本。默认为 debug 版本，指定为 `release` 即可打包 release 版本的签名，支持的 `command` 包括 `pack`, `subpack`

### `-m <mode>`

生成 wasm 文件的模式 debug|optimize，默认为 debug，即调试模式，`command` 为 `wasm` 时才支持。具体说明可查看 [WebAssembly](https://ie-activity-cn.heytapimage.com/static/minigame/CN/docs/index.html#/develop/platform-tool/webAssembly)

### `-q`

生成本地二维码。该功能需要打包工具版本在 `1.0.6` 及以上，调试器版本在 `3.9.1` 及以上，支持的 `command` 包括 `pack`, `subpack`

### `-V`

显示打包工具版本

### `-d <pub dir>`

指定执行命令的目录，默认为当前目录。支持的 `command` 包括 `pack`, `subpack`, `transfer`

### `debug --log`

在控制台输出小游戏运行日志

### `--worker <workerPath>`

指定 worker 代码根目录，具体说明可查看 [通过打包工具配置](https://ie-activity-cn.heytapimage.com/static/minigame/CN/docs/index.html#/develop/performance/worker?id=通过打包工具配置)，支持的 `command` 包括 `pack`, `subpack`

### `--help`

是否打开命令配置详情指示

## 示例

```js
// 打包用于测试的 rpk
quickgame pack
// 打包 release 签名的 rpk
quickgame pack release

// 分包打包用于测试的 rpk    
quickgame subpack            
// 分包打包 release 签名的 rpk
quickgame subpack release

// 打二维码，用于扫码调试安装
quickgame pack -q
// 分包打包
quickgame subpack -q
// 若要打 release 签名，加上 release 即可
quickgame pack release -q

// 自动转换 ts 为 wasm 文件并自动加载 wasm 文件
quickgame wasm -m debug

// 打印小游戏运行时日志
quickgame debug --log

// 微信小游戏转化为 oppo 小游戏
quickgame transfer
```
## 客服

遇到任何问题，请联系我们
<img width='30%'  src="https://ie-activity-cn.heytapimage.com/static/minigame/CN/docs/develop/games/assets/ide-talk.png" alt="微信联系方式">