使用微信小程序命令行客户端

微信小程序命令行客户端（miniprogram-ci）是微信提供的一种工具，允许开发者通过命令行对小程序进行开发、编译、预览和上传等操作，这对于自动化非常的重要。本文档介绍如何安装命令行客户端、进行后台配置、预览和上传小程序。

前提条件

在开始之前，请确保您已完成以下准备工作：

  1. 已安装 Node.js（推荐版本为 12.0.0 及以上）。
  2. 已注册微信开发者账号。
  3. 已创建微信小程序项目。

1. 安装命令行客户端

使用 npm 安装微信小程序命令行客户端：

npm install -g miniprogram-ci

2. 配置微信小程序后台

在微信开放平台中进行小程序后台配置，以便命令行客户端可以正常工作。

登录微信公众平台

  1. 打开微信公众平台，登录您的开发者账号。
  2. 进入“小程序管理”页面，选择您的小程序。

配置开发设置

  1. 在小程序管理页面，找到“开发管理”选项，点击进入。

  2. 配置服务器域名、业务域名、下载文件域名等信息。

    注意：您需要将您的服务器域名添加到白名单中，否则小程序无法正常请求您的服务器接口。以下是添加白名单的步骤：

    • 在“开发设置”页面，找到“服务器域名”部分。
    • 点击“修改”按钮，添加您的服务器域名（包括协议头，例如https://yourserver.com）。
    • 确认添加后，点击“保存”按钮。

  3. 配置业务域名：

    • 在“开发设置”页面，找到“业务域名”部分。
    • 点击“修改”按钮，添加您的业务域名。
    • 确认添加后，点击“保存”按钮。

  4. 配置下载文件域名：

    • 在“开发设置”页面，找到“下载文件域名”部分。
    • 点击“修改”按钮，添加您的下载文件域名。
    • 确认添加后，点击“保存”按钮。

获取 AppID 和 AppSecret

  1. 在“开发设置”页面，获取小程序的 AppID 和 AppSecret。
  2. 将 AppID 和 AppSecret 记录下来，后续命令行操作需要用到。

配置体验者

  1. 在“小程序管理”页面，找到“成员管理”选项，点击进入。
  2. 在“体验者”部分，添加需要进行预览和测试的小程序体验者的微信号。

上传白名单配置

您可以使用命令行工具将白名单配置上传到微信服务器，以便在命令行中进行管理。以下是一个示例命令：

miniprogram-ci upload-robots --project path/to/your/project --robots path/to/robots.txt

其中，robots.txt 文件包含需要配置的白名单域名信息，格式如下：

https://yourserver.com
https://anotherdomain.com

3. 使用命令行工具进行操作

初始化项目

在小程序项目根目录下创建项目配置文件 project.config.json：

{
  "appid": "YOUR_APP_ID",
  "projectname": "YOUR_PROJECT_NAME",
  "setting": {
    "urlCheck": true,
    "es6": true,
    "enhance": true,
    "postcss": true,
    "minified": true,
    "newFeature": true,
    "autoAudits": false,
    "coverView": true,
    "showShadowRootInWxmlPanel": true,
    "scopeDataCheck": false,
    "uglifyFileName": false,
    "compileHotReLoad": false,
    "useIsolateContext": false,
    "useCompilerModule": false,
    "userConfirmedUseCompilerModuleSwitch": false,
    "packNpmManually": false,
    "packNpmRelationList": [],
    "minifyWXML": true,
    "minifyWXSS": true,
    "minifyJS": true,
    "minify": true,
    "useStaticServer": false,
    "lazyCodeLoading": "requiredComponents",
    "useRuntime": false,
    "loadPlugin": true,
    "lazyloadPlaceholderEnable": false,
    "useMultiFrameRuntime": true,
    "useApiHook": true,
    "useApiHostProcess": true,
    "userConfirmedUseApiHostProcessSwitch": true
  },
  "compileType": "miniprogram",
  "libVersion": "2.14.0"
}

预览小程序

使用命令行工具进行小程序预览：

miniprogram-ci preview --project path/to/your/project --desc "预览版本描述" --qrcode-format image --qrcode-output-dest path/to/qrcode/destination

参数说明：

  • --project：项目根目录的路径。
  • --desc：预览版本的描述信息。
  • --qrcode-format：二维码格式，可以为 image 或 terminal。
  • --qrcode-output-dest：二维码输出路径，仅在 qrcode-format 为 image 时有效。

上传小程序

使用命令行工具上传小程序：

miniprogram-ci upload --project path/to/your/project --version "1.0.0" --desc "上传版本描述"

参数说明：

  • --project：项目根目录的路径。
  • --version：上传版本的版本号。
  • --desc：上传版本的描述信息。

提交审核

上传小程序后，需要在微信公众平台提交审核：

  1. 登录微信公众平台，进入“小程序管理”页面。
  2. 在“开发管理”页面，找到“版本管理”选项，点击进入。
  3. 在“版本管理”页面，找到刚刚上传的版本，点击“提交审核”按钮。
  4. 填写审核信息，点击“提交”按钮，等待审核通过。

发布小程序

审核通过后，可以在微信公众平台发布小程序：

  1. 登录微信公众平台，进入“小程序管理”页面。
  2. 在“开发管理”页面，找到“版本管理”选项，点击进入。
  3. 在“版本管理”页面，找到已审核通过的版本，点击“发布”按钮。
  4. 确认发布信息，点击“确定”按钮，小程序将正式上线。

4. 命令行客户端应用场景

微信小程序命令行客户端适用于以下场景：

  • 自动化构建：可以将命令行工具集成到 CI/CD 系统中，实现小程序的自动化构建、测试和部署。
  • 多环境管理：可以通过命令行工具管理多个环境（如开发、测试、生产），轻松切换和部署不同环境的小程序版本。
  • 批量操作：可以使用脚本批量处理多个小程序项目，提高开发和运维效率。
  • 远程开发：开发者可以在远程服务器上使用命令行工具进行小程序的开发和管理，无需依赖本地开发环境。

通过以上步骤，您可以使用命令行工具进行微信小程序的开发、预览、上传和发布。如果在使用过程中遇到问题，可以查阅微信官方文档或在开发者社区寻求帮助。