# @mypaas/mp-cli

> devtools

Latest version **1.0.15** (published 2022-03-03) · ISC license · 0 weekly downloads

## Install

```sh
npm install @mypaas/mp-cli
pnpm add @mypaas/mp-cli
yarn add @mypaas/mp-cli
bun add @mypaas/mp-cli
```

Provides the command `mp-cli`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.15 |
| Published | 2022-03-03 |
| First published | 2020-11-26 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 13 |
| Unpacked size | 539.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | oustn, mic.paas, william.wei, mysoft, xianaiwen |

## Links

- npm: https://www.npmjs.com/package/@mypaas/mp-cli
- Repository: https://gitlab.mypaas.com.cn/paas-miniprogram/frontend/devtools
- npm.io page: https://npm.io/package/@mypaas/mp-cli

## Dependencies (13)

- [ora](https://npm.io/package/ora.md) ^5.4.0
- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [mem-fs](https://npm.io/package/mem-fs.md) ^1.2.0
- [semver](https://npm.io/package/semver.md) ^7.3.4
- [fs-extra](https://npm.io/package/fs-extra.md) ^9.1.0
- [inquirer](https://npm.io/package/inquirer.md) ^8.0.0
- [commander](https://npm.io/package/commander.md) ^7.1.0
- [cross-env](https://npm.io/package/cross-env.md) ^7.0.3
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.1
- [child_process](https://npm.io/package/child_process.md) ^1.0.2
- [mem-fs-editor](https://npm.io/package/mem-fs-editor.md) ^8.0.0
- [@mypaas/compiler-dev-mp](https://npm.io/package/@mypaas/compiler-dev-mp.md) 1.0.6
- [validate-npm-package-name](https://npm.io/package/validate-npm-package-name.md) ^3.0.0

## Recent versions

- 1.0.15 (latest) — 2022-03-03
- 1.0.14 — 2022-03-01
- 1.0.13 — 2022-01-19
- 1.0.12 — 2022-01-19
- 1.0.11 — 2022-01-18
- 1.0.10 — 2021-12-29
- 1.0.9 — 2021-08-02
- 1.0.8 — 2021-06-11
- 1.0.7 — 2021-06-04
- 1.0.4 — 2020-11-30
- 1.0.3 — 2020-11-26
- 1.0.2 — 2020-11-26
- 1.0.1 — 2020-11-26

## README

# Devtools

开发工具。

## 安装

```shell
# 使用 npm 全局安装 CLI
$ npm install -g @mypaas/mp-cli
# OR 使用 yarn 全局安装 CLI
$ yarn global add @mypaas/mp-cli
```

## 命令

| 命令                   | 说明                 |
|------------------------|----------------------|
| `mp-cli init`          | 初始化项目           |
| `mp-cli create <name>` | 创建组件, name 为组件名             |
| `mp-cli start`         | 启动项目             |
| `mp-cli help`          | 查看命名             |
| `mp-cli -v`            | 查看当前开发工具版本 |

## 功能

### 开启小程序调试

此功能需要升级开发工具至 v1.0.14 以上版本方可使用，在终端运行 `mp-cli -v` 可查看当前全局安装的版本。

1. 在根目录下的 app.config.js 文件中添加如下代码：

```js
const path = require('path')

module.exports = {
    app: {
        mpPedestal: {
            root: path.join(__dirname, 'temp', 'wechat'),
            run: true,
        },
    }
}
```

**API**

| 属性                        | 说明                                       |
|-----------------------------|--------------------------------------------|
| app.mpPedestal              | 开发工具小程序底座配置对象                 |
| app.mpPedestal.root         | 底座存放目录，建议放在项目的 temp 目录下   |
| app.mpPedestal.run          | 是否启动小程序端调试（`start` 命令）       |
| app.mpPedestal.url          | 自定义小程序底座地址(.tar.gz)      |

1. 运行 `mp-cli init`  命令，初始化小程序底座

执行完成后，会看到在 `app.mpPedestal.root` 配置项对应的目录下载了一个基础的 taro2 项目，这就是我们的小程序底座了（可以通过配置 url 字段自定义小程序底座地址）。

2. 运行 `mp-cli start`，会执行一系列的脚本，让第2步中的 taro 项目可以直接运行起来，这样我们就可以同时在 h5 和小程序端预览效果，并实现双端热更新了。

**Tips**：

- 在浏览器设计器中操作数据后可以点击右上角的保存按钮，小程序端就会实时更新哦～

---
_Source: https://npm.io/package/@mypaas/mp-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._