# mp-assistant **Repository Path**: xx-ming/mp-assistant ## Basic Information - **Project Name**: mp-assistant - **Description**: No description available - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-09-22 - **Last Updated**: 2026-09-22 ## Categories & Tags **Categories**: Uncategorized **Tags**: 微信自动审核 ## README # 小程序助手(mp-assistant) 用于自动化管理微信小程序版本流程的 Monorepo 工具集,提供: - 多账号(Worker)统一管理 - 版本检查、批量提审、批量发布 - Web 控制台 + 本地 API + WebSocket 实时状态 ## 功能概览 - **微信小程序 Worker 管理**:新增/删除 Worker,维护登录态与小程序列表 - **任务队列执行**:任务按队列自动轮询执行,支持运行过程记录 - **核心任务类型**: - 检查版本(`wxnInspectVersion`) - 提交审核(`wxnAudit`) - 发布版本(`wxnPublish`,支持扫码确认发布) - **文件能力**:支持上传提审素材(图片/视频),并通过接口回读 - **实时通知**:通过 WebSocket 推送 Worker 列表和详情变化 ## 使用方式 ### 安装 CLI 包 从 npm 全局安装后即可在任意目录使用 `mp-assistant` 命令: ```bash # 使用 npm npm install -g @mp-assistant/cli # 或使用 pnpm pnpm add -g @mp-assistant/cli # 或使用 yarn yarn global add @mp-assistant/cli ``` 不安装也可通过 `npx` 直接运行: ```bash npx @mp-assistant/cli start ``` ### 启动服务 安装完成后,在终端执行: ```bash mp-assistant start ``` 可选参数: - `-h, --headless `:是否无头模式(true/false)。不传则沿用已保存的配置 - `-p, --port `:服务端口(默认 `3001`) - `--host `:监听地址。默认 `127.0.0.1`(仅本机可访问);传 `0.0.0.0` 允许局域网访问(此时会自动要求访问令牌) - `-t, --token `:设置访问令牌(局域网访问时校验身份),传 `auto` 由程序随机生成 示例: ```bash # 仅本机访问(默认) mp-assistant start -h false -p 3001 # 允许局域网访问,并自动生成访问令牌(令牌会打印在启动日志中) mp-assistant start --host 0.0.0.0 -t auto ``` 自定义浏览器路径:设置环境变量 `MP_ASSISTANT_CHROME_PATH` 指向 Chrome/Chromium 可执行文件即可,未设置时按「Playwright 内置 Chromium → 系统 Chrome」的顺序自动探测。 > 若在项目本地开发,也可以使用 `node packages/cli/dist/bin/index.js start` 或 `pnpm --filter @mp-assistant/cli dev` 配合构建后运行。 ## 技术栈 - **后端/CLI**:Node.js + TypeScript + Fastify + Playwright - **前端控制台**:Vue 3 + Vite + Element Plus + Pinia - **构建管理**:pnpm workspace + Turborepo ## 项目结构 ```text packages/ cli/ # 命令行入口、Fastify 服务、WS 服务 core/ # Worker 与任务执行核心(Playwright 自动化) common/ # 类型定义、API 协议、常量、工具方法 dashboard/ # Web 控制台(Vue 3) scripts/ # 辅助脚本(清理构建产物) configuration/ # 共享配置(如 tsconfig.base) ``` ## 运行环境要求 - Node.js 18+(建议 20+) - pnpm 9(项目使用 `pnpm@9.11.0`) - 可用的 Chromium/Chrome 可执行文件路径(用于 Playwright 持久化上下文) > 首次使用 Playwright 相关能力时,请确保本机浏览器运行环境完整可用。 ## 快速开始 ### 1)安装依赖 ```bash pnpm install ``` ### 2)构建全部包 ```bash pnpm build ``` ### 3)启动服务 ```bash node packages/cli/dist/bin/index.js start ``` 可选参数: - `-h, --headless `:是否无头模式(true/false)。不传则沿用已保存的配置 - `-p, --port `:服务端口(默认 `3001`) - `--host `:监听地址。默认 `127.0.0.1`(仅本机);`0.0.0.0` 允许局域网(需访问令牌) - `-t, --token `:设置访问令牌,传 `auto` 随机生成 示例: ```bash node packages/cli/dist/bin/index.js start -h false -p 3001 ``` 启动后访问: - 控制台:`http://localhost:3001` - API 前缀:`/api` - WebSocket:`/ws` > 局域网访问时,控制台会在连接失败(401)时弹窗要求输入访问令牌;令牌可从服务端启动日志获取,输入后浏览器会记住。 ## 使用流程(推荐) 1. 启动服务,进入控制台 2. 在“编辑配置”中确认浏览器路径、端口、headless 3. 新增一个微信小程序 Worker 4. 对 Worker 执行登录,扫码后拉取小程序列表 5. 添加任务(检查版本 / 提审 / 发布) 6. 通过任务运行记录和截图查看执行结果 ## 开发命令 ### 根目录 - `pnpm dev`:并行启动各包开发任务 - `pnpm build`:构建全部包 - `pnpm clear-build-product`:清理构建产物 - `pnpm commit`:使用 commitizen 提交 ### 常用子包 - `pnpm --filter @mp-assistant/cli dev`:CLI 代码 watch 编译 - `pnpm --filter @mp-assistant/dashboard dev`:启动前端开发服务(默认 `3002`) `dashboard` 开发环境默认使用: - `VITE_BASE_API_URL="http://localhost:3001"` 对应文件:`packages/dashboard/.env.development` ## 本地数据目录 本地运行数据统一存放在**用户目录**下,与执行命令时的目录解耦(早期版本写在 `node_modules` 下,换目录启动会丢失全部 Worker 与登录态): - `~/.mp-assistant/.chrome_user_data/`:浏览器持久化上下文(按 Worker 隔离) - `~/.mp-assistant/.store/`:本地配置与 Worker 列表缓存 - `~/.mp-assistant/.files/`:上传文件与任务截图等产物 如需自定义根目录,设置环境变量 `MP_ASSISTANT_DATA_DIR` 指向目标路径即可。 ## 安全说明 本工具会操作微信小程序后台(含**提交审核、发布线上版本**等敏感能力),请注意网络暴露范围: - **默认只监听 `127.0.0.1`**:仅本机可访问,局域网内其他设备无法连入。 - **局域网访问需令牌**:当监听地址为 `0.0.0.0`(或具体网卡 IP)时,来自本机的请求仍免令牌放行,**来自其他设备的请求必须携带访问令牌**(启动日志中打印,或由本机控制台弹窗输入)。 - **CORS 收紧**:不再允许任意来源(`*`),仅放行回环来源与你在配置中显式允许的 `allowedOrigins`。 - 文件读取接口(`/get-file`)限定在上传根目录内,无法读取目录之外的文件。 - 若仅在自己机器使用,建议保持默认绑定,不要开启 `0.0.0.0`。 ## API 说明(简版) 统一前缀:`/api` - 配置:`/config`(GET/POST) - Worker:`/worker-list`、`/worker-add`、`/worker-login`、`/worker-addTask` 等 - 文件:`/upload-file`、`/get-file` 接口定义可参考:`packages/common/src/api/modules/` ## 注意事项 - 发布任务依赖微信侧扫码确认,执行时会生成发布二维码截图 - 若 `executablePath` 配置错误,新增 Worker 会失败 - Worker 登录态失效时,任务会受影响,建议先执行登录与小程序列表刷新 ## License ISC