# nanami-cli

> Command-line interface tool for creating project

Latest version **1.0.0** (published 2021-01-18) · ISC license · 0 weekly downloads

## Install

```sh
npm install nanami-cli
pnpm add nanami-cli
yarn add nanami-cli
bun add nanami-cli
```

Provides the command `nanami`.

## 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.0 |
| Published | 2021-01-18 |
| First published | 2021-01-18 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 12 |
| Unpacked size | 16.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | fanzheming |
| Maintainers | fanzheming |
| Keywords | cli |

## Links

- npm: https://www.npmjs.com/package/nanami-cli
- Repository: https://github.com/fanzheming/dio-cli
- Homepage: https://github.com/fanzheming/dio-cli#readme
- Issues: https://github.com/fanzheming/dio-cli/issues
- npm.io page: https://npm.io/package/nanami-cli

## Dependencies (12)

- [ora](https://npm.io/package/ora.md) ^5.2.0
- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.20
- [shelljs](https://npm.io/package/shelljs.md) ^0.8.4
- [fs-extra](https://npm.io/package/fs-extra.md) ^9.0.1
- [inquirer](https://npm.io/package/inquirer.md) ^7.3.3
- [commander](https://npm.io/package/commander.md) ^6.2.1
- [node-emoji](https://npm.io/package/node-emoji.md) ^1.10.0
- [log-symbols](https://npm.io/package/log-symbols.md) ^4.0.0
- [module-alias](https://npm.io/package/module-alias.md) ^2.2.2
- [download-git-repo](https://npm.io/package/download-git-repo.md) ^3.0.2
- [validate-npm-package-name](https://npm.io/package/validate-npm-package-name.md) ^3.0.0

## 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.0.0 (latest) — 2021-01-18

## README

# Nanami-CLI

> 🛠️选择模板项目下载到本地并且初始化依赖。

## 前言

目前市面上许多流行框架的脚手架如[vue-cli](https://github.com/vuejs/vue-cli)、[create-react-app](https://github.com/facebook/create-react-app)等，都不能直接上手直接开发写业务。大部分项目都需要自己进行一些前置工作，例如二次封装网络请求、按模块进行状态管理、移动端的适配等。为了不进行这些重复性的劳作，自己对此进行了一些必要的技术收敛，由此编写了模板项目放在github仓库中。本脚手架工具的目的是让用户可以通过自定义选项，选择契合的模板项目，快速下载到本地并且自动进行依赖安装。此外，用户也可以通过命令自行添加或删除自己的仓库在其中。

## 安装

```bash
npm install nanami-cli -g
```

## 使用

1. **创建项目**

	```bash
	$ nanami create <project-name>
	
	example:
	$ nanami create my-project
	```

	> ​	tips：
	>
	> 1.若需要在当前目录下直接创建项目，那么项目名只需要输入`.`，此时项目名为当前目录名;
	> 2.若项目名重名，则需要继续选择覆盖或者取消，`--force`可强行覆盖（谨慎操作）；

2. **查看所有模板（预设模板+自定义模板）**

	```bash
	$ nanami list or $ nanami ls
	```

3. **新增自定义模板**

	```bash
	$ nanami add <name> <url>
	
	example:
	$ nanami add vue-admin https://github.com/fanzheming/vue-admin.git#master
	```

	> ​	tips：`#`后需要跟上分支名。

4. **删除自定义模板**

	```bash
	$ nanami remove <name>
	
	example:
	$ nanami remove vue-admin
	```

	> ​	tips：只可删除自定义模板，预设模板不可删除。

5. **其它**

	```bash
	$ nanami --version or nanami -V        // 查看版本号
	
	$ nanami --help                     // 获取帮助信息
	```

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