QQ小程序 命令行調(diào)用

開發(fā)者工具提供了命令行工具與 HTTP 服務(wù)兩種方式供外部調(diào)用，開發(fā)者可以通過命令行或 HTTP 請(qǐng)求指示工具進(jìn)行登錄、預(yù)覽、上傳等操作。

命令行工具說明

通過命令行調(diào)用安裝完成的工具可執(zhí)行文件，完成登錄、打開、關(guān)閉、預(yù)覽、上傳等操作。

命令行工具所在位置：

• macOS： 安裝路徑/Contents/MacOS/cli。（訪達(dá) -> 打開應(yīng)用程序 -> 找到QQ小程序開發(fā)者工具.app -> 右鍵 -> 點(diǎn)擊顯示包內(nèi)容 -> 依次打開文件夾Contents、MacOS）

• Windows： 安裝路徑/cli.bat。（安裝路徑：安裝開發(fā)者工具時(shí)選擇的安裝路徑）

命令行工具使用方式：

• 開啟安全服務(wù)端口： 打開開發(fā)者工具 -> 打開 工具欄-設(shè)置 選項(xiàng) -> 選擇“安全”設(shè)置 -\> 開啟服務(wù)端口。服務(wù)端口開啟后，下次打開開發(fā)者工具會(huì)自動(dòng)打開安全服務(wù)端口。

• 執(zhí)行命令： 打開命令行工具所在目錄，在終端或cmd窗口執(zhí)行命令，如 打開開發(fā)者工具：cli -o。

tips:

• 以下cli命令均需在 “mac安裝路徑/Contents/MacOS” 或 “windows安裝路徑” 目錄下執(zhí)行

• 除了cli -o命令，其他命令均需在安全服務(wù)端口打開的情況下執(zhí)行

可用命令

1 查看幫助

使用以下命令查看命令行工具幫助信息，可查看所有可用命令：

cli -h
cli --help

2 打開開發(fā)者工具或項(xiàng)目窗口

-o, --open [projectpath]: 打開開發(fā)者工具，如果不帶 projectpath，只是打開工具。如果帶 project path，則打開路徑中的項(xiàng)目。projectpath 不能是相對(duì)路徑。項(xiàng)目路徑中必須含正確格式的 project.config.json 且其中有 appid 和 projectname 字段。

示例：

## 打開工具 #
cli -o
## 打開路徑 /Users/username/demo 下的項(xiàng)目 #
cli -o /Users/username/demo

3 指定工具 HTTP 服務(wù)端口號(hào)

--port [number]: 該命令需配合其他命令使用，如果工具沒有打開，則自動(dòng)打開工具，工具將以給定端口號(hào)啟動(dòng) HTTP 服務(wù)，如果工具已打開且端口不同于指定的端口號(hào)，將關(guān)閉之前的端口號(hào)并打開新的端口號(hào)。

示例：

cli --port 3000 -o

4 命令行登錄

命令行提供兩種登錄方式：一是將登錄二維碼轉(zhuǎn)成 base64 給用戶，讓用戶自己集成到自己系統(tǒng)中使用；二是將二維碼打印在命令行中。

-l, --login: 啟動(dòng)登錄邏輯。

--login-qr-output [format[@path]]: 指定二維碼輸出形式，format 可選值包括 terminal（命令行輸出）, base64, image。如果有填 path，表示結(jié)果輸出到指定路徑的文件中。如果沒填 path，表示將結(jié)果輸出到命令行。不使用此選項(xiàng)或使用了但沒有填 format 的話則默認(rèn)為命令行打印。

--login-result-output [path]: 輸出登錄結(jié)果到指定文件

示例：

## 登錄，在終端中打印登錄二維碼
cli -l
## 登錄，在終端中打印登錄 base64 形式的二維碼
cli -l --login-qr-output base64
## 登錄，二維碼轉(zhuǎn)成 base64 并存到文件 /Users/username/code.txt
cli -l --login-qr-output base64@/Users/username/code.txt
## 登錄，并輸出登錄結(jié)果到文件 /Users/username/result.json
cli -l --login-result-output /Users/username/result.json

5 預(yù)覽

預(yù)覽時(shí)必須處于登錄狀態(tài)，如果沒有登錄，會(huì)提示需先登錄。預(yù)覽的二維碼可命令行打印也可以轉(zhuǎn)成 base64。ES6 等項(xiàng)目配置從 project.config.json 讀。

-p, --preview [project_root]: 預(yù)覽代碼，project_root 指定項(xiàng)目根路徑。

--preview-qr-output [format[@path]]: 指定二維碼輸出形式，語(yǔ)義同登錄用的選項(xiàng) --login-qr-output。

--preview-info-output [path]: 指定后，會(huì)將本次預(yù)覽的額外信息以 json 格式輸出至指定路徑，如代碼包大小、分包大小信息。

--compile-condition '[json]': 指定自定義編譯條件，json 條件可指定兩個(gè)字段，pathName 表示打開的頁(yè)面，不填表示首頁(yè)，query 表示頁(yè)面參數(shù)

示例：

### 預(yù)覽，在終端中打印登錄二維碼
cli -p /Users/username/demo
### 預(yù)覽，二維碼轉(zhuǎn)成 base64 并存到文件 /Users/username/code.txt
cli -p /Users/username/demo --preview-qr-output base64@/Users/username/code.txt
### 預(yù)覽，并將預(yù)覽代碼包大小等信息存入 /Users/username/info.json
cli -p /Users/username/demo --preview-info-output /Users/username/info.json
### 預(yù)覽，指定自定義編譯條件，pathName
cli --compile-condition '{"pathName":"pages/index/index","query":"x=1&y=2"}'

6 上傳代碼

上傳代碼時(shí)必須處于登錄狀態(tài)，如果沒有登錄，會(huì)提示需先登錄。

上傳代碼需要的信息包括項(xiàng)目根目錄、版本號(hào)、版本備注。

-u, --upload [version@project_root]: 上傳代碼，version 指定版本號(hào)，project_root 指定項(xiàng)目根路徑。

--upload-desc [desc]: 上傳代碼時(shí)的備注。

--upload-info-output [path]: 指定后，會(huì)將本次上傳的額外信息以 json 格式輸出至指定路徑，如代碼包大小、分包大小信息。

示例：

## 上傳路徑 /Users/username/demo 下的項(xiàng)目，指定版本號(hào)為 1.0.0，版本備注為 initial release
cli -u 1.0.0@/Users/username/demo --upload-desc 'initial release'
## 上傳并將代碼包大小等信息存入 /Users/username/info.json
cli -u 1.0.0@/Users/username/demo --upload-desc 'initial release' --upload-info-output /Users/username/info.json

7 構(gòu)建 npm

命令行觸發(fā) npm 構(gòu)建。

--build-npm [project_root]: 按照 project.config.json 中的配置構(gòu)建，行為和菜單欄的構(gòu)建 NPM 一致 --build-npm-compile-type [type]：手動(dòng)指定編譯類型（"miniprogram" | "plugin"），用于指定走 miniprogramRoot 還是 pluginRoot，優(yōu)先級(jí)比 project.config.json 中的高

示例：

cli --build-npm /Users/username/demo

8 關(guān)閉當(dāng)前項(xiàng)目窗口

通過命令行觸發(fā)項(xiàng)目窗口關(guān)閉

--close [project_root]: 如果指定的 project_root 項(xiàng)目被打開，將會(huì)被自動(dòng)關(guān)閉

示例：

## 關(guān)閉指定項(xiàng)目
cli --close /Users/username/demo

9 關(guān)閉開發(fā)者工具

通過命令行退出開發(fā)者工具

--quit: 退出開發(fā)者工具

## 退出開發(fā)者工具
cli --quit