微信小程序工具 命令行調用

開發(fā)者工具提供了命令行與 HTTP 服務兩種接口供外部調用，開發(fā)者可以通過命令行或 HTTP 請求指示工具進行登錄、預覽、上傳等操作。

命令行

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

命令行工具所在位置：

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

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

1. 命令行啟動工具

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

示例：

# 打開工具
cli -o
# 打開路徑 /Users/username/demo 下的項目
cli -o base64@/Users/username/demo

2. 命令行登錄

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

-l, --login: 啟動登錄邏輯。

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

示例：

# 登錄，在終端中打印登錄二維碼
cli -l
# 登錄，在終端中打印登錄 base64 形式的二維碼
cli -l --login-qr-output base64
# 登錄，二維碼轉成 base64 并存到文件 /Users/username/code.txt 
cli -l --login-qr-output base64@/Users/username/code.txt

3. 命令行提交預覽

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

-p, --preview <project_root>: 預覽代碼，project_root 指定項目根路徑。

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

示例：

# 預覽，在終端中打印登錄二維碼
cli -p /Users/username/demo
# 預覽，二維碼轉成 base64 并存到文件 /Users/username/code.txt
cli -p /Users/username/demo --preview-qr-output base64@/Users/username/code.txt

4. 命令行上傳代碼

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

上傳代碼需要的信息包括項目根目錄、版本號、以及可選的版本備注。

-u, --upload <version@project_root>: 上傳代碼，version 指定版本號，project_root 指定項目根路徑。

--upload-desc <desc>: 上傳代碼時的備注。

示例：

# 上傳路徑 /Users/username/demo 下的項目，指定版本號為 1.0.0，版本備注為 initial release
cli -u 1.0.0@/Users/username/demo --upload-desc 'initial release'

5. 支持自動化測試

-t, --test <project_root>: 提交自動化測試，project_root 指定項目根路徑。

示例：

# 提交測試路徑 /Users/username/demo 下的項目
cli -t /Users/username/demo