# create-miniprogram > create miniprogram cli Latest version **1.2.3** (published 2019-05-18) · MIT license · 0 weekly downloads ## Install ```sh npm install create-miniprogram pnpm add create-miniprogram yarn add create-miniprogram bun add create-miniprogram ``` Provides the command `create-miniprogram`. ## 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.2.3 | | Published | 2019-05-18 | | First published | 2019-02-16 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | >= 4.0.0 | | Dependencies | 8 | | Unpacked size | 52.4 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 1 | | Author | New Future | | Maintainers | newfuture | | Keywords | create, miniprogram, cli, template | ## Links - npm: https://www.npmjs.com/package/create-miniprogram - Repository: https://github.com/NewFuture/create-miniprogram - Homepage: https://github.com/NewFuture/create-miniprogram#readme - Issues: https://github.com/NewFuture/create-miniprogram/issues - npm.io page: https://npm.io/package/create-miniprogram ## Dependencies (8) - [glob](https://npm.io/package/glob.md) ^7.1.4 - [rimraf](https://npm.io/package/rimraf.md) ^2.6.2 - [download](https://npm.io/package/download.md) ^7.1.0 - [inquirer](https://npm.io/package/inquirer.md) ^6.3.1 - [progress](https://npm.io/package/progress.md) ^2.0.0 - [commander](https://npm.io/package/commander.md) ^2.20.0 - [filenamify](https://npm.io/package/filenamify.md) ^4.0.0 - [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.4.4 ## Alternatives - [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads - [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads - [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads - [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads - [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads ## Recent versions - 1.2.3 (latest) — 2019-05-18 - 1.2.2 — 2019-05-18 - 1.2.1 — 2019-02-24 - 1.2.0 — 2019-02-24 - 1.1.0 — 2019-02-22 - 1.0.0 — 2019-02-17 - 0.1.0 — 2019-02-16 - 0.0.1 — 2019-02-16 ## README # create-miniprogram [![npm](https://img.shields.io/npm/v/create-miniprogram.svg)](https://www.npmjs.com/package/create-miniprogram) [![Build Status](https://travis-ci.com/NewFuture/create-miniprogram.svg)](https://travis-ci.com/NewFuture/create-miniprogram) [![Greenkeeper badge](https://badges.greenkeeper.io/NewFuture/create-miniprogram.svg)](https://greenkeeper.io/) 小程序开发相关命令行工具 兼容[miniprogram-cli](https://github.com/wechat-miniprogram/miniprogram-cli): * **从任意git模板创建** * 支持 **typescript模板** * 自定义组件（custom-component） * 小程序 quickstart（miniprogram） * 小程序插件 quickstart（plugin） * 小游戏 quickstart（game） ## 环境 * `node` >= `4.0.0` * `npm` >= `6.0.0` 或者 `yarn`(下列命令中用`yarn`代替`npm`即可) ## Usage `npm create miniprogram` 查看帮助信息 ### 从git模板新建 ``` npm create miniprogram 仓库地址 [dirPath] ``` * `repo`: git地址, [type:]owner/repository[#branch] 或者直接粘贴URL ,支持 GitHub,Gitlab和bitbucket * `dirPath`: 本地目录, 默认当前目录 examples: * `npm create miniprogram NewFuture/miniprogram-template` * `npm create miniprogram https://github.com/NewFuture/miniprogram-template` | option | 描述 | |---|---| | -f, --force | 强制初始化项目，可能会覆盖掉目录中已存在的项目 | | -p, --proxy | 下载/更新模板时的请求代理 | | -n, --no-cache | 使用线上最新的模板进行项目的初始化 | ### 新建官方js模板 ``` npm create miniprogram new ``` 根据模板来进行项目的初始化 支持 options 如下： | option | 描述 | |---|---| | -t, --type | 项目的初始化所使用的模板 | | -f, --force | 强制初始化项目，可能会覆盖掉目录中已存在的项目 | | -p, --proxy | 下载/更新模板时的请求代理 | | -n, --no-cache | 使用线上最新的模板进行项目的初始化 | ### 升级 ``` npm create miniprogram upgrade [options] [dirPath] ``` 根据最新模板对已有项目进行升级。目前仅支持**自定义组件**项目。 支持 options 如下： | option | 描述 | |---|---| | -f, --force | 强制升级项目，会覆盖掉原有项目中的构建相关文件 | | -p, --proxy | 下载/更新模板时的请求代理 | ### 缓存管理 ``` npm create miniprogram cache [options] ``` 显示缓存目录。 支持 options 如下： | option | 描述 | |---|---| | -c, --clear | 清空缓存的模板 | ### 全局安装 ``` npm i create-miniprogram -g create-miniprogram ``` --- _Source: https://npm.io/package/create-miniprogram · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._