@wechat-mp/cli/README.md

微信小程序脚手架，集成 Taro、uniapp 第三方模版，支持小程序 CI 上传，预览，发布

# 微信小程序脚手架 @wechat-mp/cli

微信小程序脚手架，集成 Taro、uniapp 第三方模版，支持小程序 CI 上传，预览，发布

## 注意事项

**需要在微信公众平台开发管理-开发设置-IP 白名单配置 IP 信息，否则预览、上传会失败**

## Installation

```javascript
npm install -g @wechat-mp/cli
```

## Usage

### 创建项目

```javascript
mp create myProject
```

**支持三种项目模版,选择对应版本即可下载模版到当前目录下**

![image.png](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/bd693263ad69452b92399af3aba37575~tplv-k3u1fbpfcp-watermark.image?)

### CI 相关

**初始化**

```javascript
mp ci -i
```

执行该命令会在本地当前项目根目录生成`ci.config.js`配置文件，需要配置相应的项目信息，才能进行项目预览及上传

| 字段名称       | 类型   | 说明                                                                                                     |
| -------------- | ------ | -------------------------------------------------------------------------------------------------------- |
| appid          | string | 合法的小程序/小游戏 appid                                                                                |
| type           | string | 显示指明当前的项目类型, 默认为 miniProgram，有效值 miniProgram/miniProgramPlugin/miniGame/miniGamePlugin |
| projectPath    | string | 项目路径                                                                                                 |
| privateKeyPath | string | 私钥的路径                                                                                               |
| ignores        | array  | 指定需要排除的规则                                                                                       |

**上传**

```javascript
mp ci -u
```

执行命令，填写相应的项目信息，上传完成后即可在微信公众平台上查看到版本信息

**预览**

```javascript
mp ci -p
```

命令执行完成后，会在项目的根目录生成`preview.jpg`二维码文件，打开扫码即可查看预览版本