weapp-ide-cli

weapp-ide-cli 是对「微信开发者工具」官方命令行的增强封装，提供更友好的参数体验、路径兼容与配置管理能力，帮助你在本地与持续集成环境中高效调用工具链。

开始前请在微信开发者工具中打开「设置 → 安全设置 → 服务端口」。

功能亮点

• 自动识别或记忆微信开发者工具 cli 所在位置，避免反复输入路径。
• 为 -p / --project、--qr-output 等选项自动补全绝对路径，默认使用当前工作目录。
• 使用与官方指令完全一致的调用方式，便于在脚本中无缝迁移。
• 支持 macOS、Windows 以及安装了社区版工具的 Linux 桌面环境。
• 内置支付宝小程序 CLI 入口，直接转发至官方 minidev 工具。

安装

# 使用 pnpm
pnpm add -g weapp-ide-cli

# 或使用 npm
npm install -g weapp-ide-cli

# 或使用 yarn
yarn global add weapp-ide-cli

快速开始

# 打开微信开发者工具（项目目录为当前终端所在位置）
weapp open -p

# 启动并加载指定项目
weapp open --project ./dist/dev/mp-weixin

# 执行预览、上传等官方支持的命令
weapp preview
weapp upload --project ./dist/build/mp-weixin

weapp 与 weapp-ide-cli 等价，选择任一前缀即可。

支付宝小程序（minidev）支持

封装内置了支付宝官方 CLI —— minidev 的调用入口，可通过 weapp alipay 或 weapp ali 直接转发指令：

# 调用 minidev 登录
weapp alipay login

# 预览支付宝小程序
weapp alipay preview --project ./dist/mp-alipay

首次使用前请确认已全局安装 minidev（例如执行 pnpm add -g minidev）。若命令不存在，CLI 会给出安装提示。

也支持通过 open 命令直接指定平台为支付宝，此时会自动转发到 minidev ide：

weapp open --platform alipay -p ./dist/dev/mp-alipay

命令大全

1. 微信官方 CLI 透传命令（V2）

下列命令会透传到微信开发者工具官方 CLI（weapp 只在外层补了路径兼容、配置与错误处理）：

| 命令 | 说明 | | ----------------------- | --------------- | | weapp open | 打开 IDE / 项目 | | weapp login | 重新登录 IDE | | weapp islogin | 检查登录状态 | | weapp preview | 预览二维码 | | weapp auto-preview | 自动预览 | | weapp upload | 上传小程序 | | weapp build-npm | 构建 npm | | weapp auto | 开启自动化 | | weapp auto-replay | 自动化回放 | | weapp reset-fileutils | 重置文件工具 | | weapp close | 关闭项目 | | weapp quit | 退出 IDE | | weapp cache | 清理缓存 | | weapp engine | 引擎相关命令 | | weapp open-other | 打开其它项目 | | weapp build-ipa | 生成 iOS 包 | | weapp build-apk | 生成 Android 包 | | weapp cloud | 云开发命令 |

官方文档：

• https://developers.weixin.qq.com/miniprogram/dev/devtools/cli.html

2. automator 增强命令

weapp-ide-cli 内置 automator 子命令：

| 命令 | 说明 | | -------------------------------- | ------------------------------ | | weapp screenshot | 截图（支持 base64 / 文件输出） | | weapp navigate <url> | 保留栈跳转页面 | | weapp redirect <url> | 重定向页面 | | weapp back | 页面返回 | | weapp relaunch <url> | 重启到指定页面 | | weapp switch-tab <url> | 切换到 tabBar 页 | | weapp page-stack | 查看页面栈 | | weapp current-page | 查看当前页面 | | weapp system-info | 查看系统信息 | | weapp page-data [path] | 查看页面数据 | | weapp tap <selector> | 点击元素 | | weapp input <selector> <value> | 元素输入 | | weapp scroll <scrollTop> | 页面滚动 | | weapp audit | 体验评分审计 | | weapp remote [--disable] | 开关远程调试 |

帮助查看方式：

weapp help navigate
weapp navigate --help

3. config 子命令

| 命令 | 说明 | | -------------------------------------------- | ----------------------------------- | | weapp config | 交互式配置 CLI 路径 | | weapp config lang <zh\|en> | 切换并保存语言 | | weapp config set-lang <zh\|en> | lang 的别名 | | weapp config show | 显示完整配置 JSON | | weapp config get <cliPath\|locale> | 读取单个配置项 | | weapp config set <cliPath\|locale> <value> | 写入配置项 | | weapp config unset <cliPath\|locale> | 删除配置项 | | weapp config doctor | 配置健康诊断 | | weapp config export [path] | 导出配置（不传 path 则输出 stdout） | | weapp config import <path> | 从 JSON 文件导入配置 |

4. 支付宝 minidev 转发命令

| 命令 | 说明 | | ---------------------------------- | ---------------------------- | | weapp alipay <args...> | 透传到 minidev | | weapp ali <args...> | alipay 别名 | | weapp open --platform alipay ... | 自动转发为 minidev ide ... |

5. 程序化命令目录导出

可在 Node 侧直接复用 weapp-ide-cli 的命令目录判断能力：

import {
  isWeappIdeTopLevelCommand,
  WEAPP_IDE_TOP_LEVEL_COMMAND_NAMES,
} from 'weapp-ide-cli'

if (isWeappIdeTopLevelCommand('preview')) {
  // 命中 weapp-ide-cli 顶层命令，可执行透传
}

console.log(WEAPP_IDE_TOP_LEVEL_COMMAND_NAMES)

路径与参数兼容

• -p 会被自动替换为 --project，并且相对路径会解析为绝对路径。
• --qr-output、--result-output、--info-output 及其短选项在缺省值时会默认指向当前工作目录。
• 如果未显式提供路径参数，CLI 会自动注入当前终端所在目录，方便脚本化调用。

配置 CLI 所在位置

执行一次互动式配置即可持久化工具路径：

weapp config

也可以通过命令直接切换语言并写入同一配置文件：

weapp config lang zh
weapp config lang en

配置子命令：

# 查看完整配置（JSON）
weapp config show

# 读取单个配置项
weapp config get cliPath
weapp config get locale

# 设置配置项
weapp config set cliPath /Applications/wechatwebdevtools.app/Contents/MacOS/cli
weapp config set locale en

# 清除配置项
weapp config unset cliPath
weapp config unset locale

# 诊断配置可用性
weapp config doctor

# 导出 / 导入配置
weapp config export ./weapp-ide-cli.config.json
weapp config import ./weapp-ide-cli.config.json

配置数据保存在用户目录：

• macOS / Linux：~/.weapp-ide-cli/config.json
• Windows：C:\Users\<用户名>\.weapp-ide-cli\config.json

可以直接编辑该文件或重新运行 weapp config 来更新路径。当配置文件缺失或留空时，CLI 会尝试按系统默认安装位置自动寻找。

配置文件示例：

{
  "cliPath": "/Applications/wechatwebdevtools.app/Contents/MacOS/cli",
  "locale": "zh"
}

平台支持与限制

| 平台 | 支持情况 | 默认查找路径 | | --------------- | ------------- | ---------------------------------------------------------- | | macOS | ✅ | /Applications/wechatwebdevtools.app/Contents/MacOS/cli | | Windows | ✅ | C:\Program Files (x86)\Tencent\微信web开发者工具\cli.bat | | Linux（社区版） | ⚠️ 需手动安装 | 通过 PATH 搜索 wechat-devtools-cli |

若所属平台未检测到 CLI，请使用 weapp config 指定安装位置。

在脚本或 CI 中使用

1. 确保执行环境已安装微信开发者工具并开启服务端口。
2. 首次运行前可通过 weapp config 写入 CLI 路径，也可在 CI 中直接向 ~/.weapp-ide-cli/config.json 写入。
3. 在自动化流程中建议加上 --qr-output、--result-output 等参数，以便收集产物或日志。

推荐在 CI 或非交互脚本里显式启用非交互模式，避免登录失效时卡在按键等待：

weapp build-npm -p --non-interactive

登录重试相关参数：

• --non-interactive：非交互模式，登录失效时直接失败（退出码语义保留为 10）。
• --login-retry=never|once|always：控制登录失效后的重试策略。
• --login-retry-timeout=<ms>：交互重试等待超时（默认 30000）。

当检测到以下场景时，会自动启用非交互模式：

• CI=true
• stdin 非 TTY

语言切换（默认中文）

weapp-ide-cli 的增强提示、错误信息与 automator 帮助默认使用中文。 可通过 --lang en 切换为英文，也可通过环境变量 WEAPP_IDE_CLI_LANG=en 统一设置。

# 单次命令切换英文
weapp help navigate --lang en

# 环境变量方式
WEAPP_IDE_CLI_LANG=en weapp navigate pages/index/index -p ./mini-app

参数前置校验（增强）

为减少进入微信 CLI 后才失败的情况，weapp-ide-cli 会在本地先做一部分参数校验：

• upload 必须提供 --version/-v 与 --desc/-d（且值不能为空字符串）
• preview 的 --qr-format/-f 仅支持 terminal / image / base64
• preview / upload / auto / auto-preview 需要提供 --project 或 --appid
• --ext-appid 在未提供 --project 时必须同时提供 --appid
• --port 必须为正整数
• --login-retry 仅支持 never / once / always
• --login-retry-timeout 必须为正整数

常见问题

• 命令执行后无反应：请确认微信开发者工具已开启服务端口，并尝试重新登录或升级工具版本。
• 提示 需要重新登录 或 code: 10：表示微信开发者工具登录态失效。交互模式下可按 r 重试，按 q、Esc 或 Ctrl+C 取消；非交互模式（含 CI / 非TTY）会直接失败返回非 0。
• 提示未找到 CLI：检查配置文件中的路径是否真实存在，可使用绝对路径避免解析误差。
• Linux 环境报错：需安装社区版工具并将 wechat-devtools-cli 加入 PATH，否则只能手动指定路径。
• upload 报参数缺失：weapp upload 现在会在本地前置校验 --version/-v 与 --desc/-d，缺失时直接报错以避免触发远端失败。

贡献

欢迎通过 Issues 或 Pull Request 提交优化建议，开发前请阅读仓库根目录的 CONTRIBUTING.md。

许可证

MIT