微信小程序工具 命令行調(diào)用

開(kāi)發(fā)技術(shù) 2018/2/15

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

命令行

通過(guò)命令行調(diào)用安裝完成的工具可執(zhí)行文件，完成登錄、預(yù)覽、上傳、自動(dòng)化測(cè)試等操作。調(diào)用返回碼為 0 時(shí)代表正常，為 -1 時(shí)錯(cuò)誤。

命令行工具所在位置：

macOS: <安裝路徑>/Contents/Resources/app.nw/bin/cli

Windows: <安裝路徑>/cli.bat

1. 命令行啟動(dòng)工具

-o, --open [projectpath]: 打開(kāi)工具，如果不帶 projectpath，只是打開(kāi)工具。如果帶 project path，則打開(kāi)路徑中的項(xiàng)目，每次執(zhí)行都會(huì)自動(dòng)編譯刷新，并且自動(dòng)打開(kāi)模擬器和調(diào)試器。projectpath 不能是相對(duì)路徑。項(xiàng)目路徑中必須含正確格式的 project.config.json 且其中有 appid 和 projectname 字段。

示例：

# 打開(kāi)工具

cli -o

# 打開(kāi)路徑 /Users/username/demo 下的項(xiàng)目

cli -o base64@/Users/username/demo

2. 命令行登錄

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

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

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

示例：

# 登錄，在終端中打印登錄二維碼

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

3. 命令行提交預(yù)覽

預(yù)覽時(shí)必須處于登錄狀態(tài)，如果沒(mé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。

示例：

# 預(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

4. 命令行上傳代碼

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

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

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

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

示例：

# 上傳路徑 /Users/username/demo 下的項(xiàng)目，指定版本號(hào)為 1.0.0，版本備注為 initial release

cli -u 1.0.0@/Users/username/demo --upload-desc 'initial release'

5. 支持自動(dòng)化測(cè)試

-t, --test <project_root>: 提交自動(dòng)化測(cè)試，project_root 指定項(xiàng)目根路徑。

示例：

# 提交測(cè)試路徑 /Users/username/demo 下的項(xiàng)目

cli -t /Users/username/demo