README

install

（1）全局安装：

npm install sparrow-miniapp-cli -g

（2）也可以只在项目中安装：

npm install sparrow-miniapp-cli --save-dev

在package.json的scripts属性下加上：

  "scripts": {
    ...
    "cli": "cli "
  },

在使用的时候不能像全局安装那样直接使用cli了，需要在指令前面加上npx。比如，全局安装时上传代码用的是cli -u，只在项目中安装时需要使用npx cli -u。

usage

1.使用命令行工具的前提条件是，在微信开发者工具中把服务端口打开。

设置 -> 安全设置 -> 服务端口

2.执行cli指令初始化之后，会生成一个cli.js文件，文件内容是这样的：

module.exports = {
  "environment": "DEV",
  "version": "版本号",
  "description": "描述文本",
  "devToolPath": "微信开发者工具的命令行工具的安装路径",
  "projectRoot": "电脑里面项目的路径",
  "needCheckNpmPackages": ["需要检查的包的名字"]
};

在项目代码中引入这个文件的数据，主要是前三个属性，来进行一些处理。

3.指令使用方式：cli <command>

<command> 是以下选项中的一个：

选项	简写	作用
`--upload`	`-u`	上传代码
`--preview`	`-p`	预览
`--switch`	`-s`	切换环境
`--create <type>`	`-c`	创建页面模板或组件模板
		`<type>`的值是`page`或`component`
`--build-npm`	`-b`	npm构建
`--login`	`-l`	登录开发者工具
`--open`	`-o`	打开开发者工具
`--quit`	`-q`	关掉开发者工具
`--close`	`-cl`	关闭项目窗口
`--help`	`-h`	描述如何使用

比如，上传代码：

cli --upload

4.注意：

node版本需大于等于v14.9.0。

Usage no npm install needed!

README

install

usage