# mai-cli

**Repository Path**: qiansihui/mai-cli

## Basic Information

- **Project Name**: mai-cli
- **Description**: 基于Node搭建生成个人前端脚手架（vue）
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-02-18
- **Last Updated**: 2023-02-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[English](./README.EN.md) | 简体中文

<p align="center"><img width="100" src="https://vuejs.org/images/logo.png"></p>

<h2 align="center">mai-cli（一个简单的前端CLI工具）</h2>
<p align="center"><b>基于Node搭建生成个人前端脚手架（vue）</b></p>

# 目录

- [特性](#特性)
- [快速入门](#快速入门)
  - [安装](#安装)
  - [用法](#用法)
- [贡献者们](#贡献者们)
- [维护者](#维护者)
- [License](#license)

### 特性

- 简单易用
- 支持自定义模板增删

## 快速入门

### 安装

```bash
$ npm i mai-cli -g               # install cli
$ omi init my-app     # init project, you can also exec 'omi init' in an empty folder
$ cd my-app           # please ignore this command if you executed 'omi init' in an empty folder
$ mai init [templateName] [yourProjectName]
```

安装说明:

默认的脚手架模板名称是 vue-admin

> mai init vue-admin [yourProjectName]

### 新增模板用法

```bash
mai add
# 选择模板和模板地址（github地址）
```

![mai-add](./img/readme_add.png)

- 注意：模板地址为 git 仓库名称 默认拉取 master 分支
  如果想指定分支 请使用 **owner/name#my-branch**的方式
  ![mai-add](./img/readme_gitAddress.png)

### 删除模板用法

```bash
mai delete
# 选择模板
```

![mai-add](./img/readme_delete.png)

### 查看所有模板用法

```bash
mai list
```

### 初始化项目脚手架用法

```bash
mai init 或者 mai init [templateName] [yourProjectName]
```

![mai-add](./img/readme_init.png)

## 贡献者们

- maimai-sweet

## 维护者

- [maimai-sweet](https://github.com/BigSharkLx)

## License

- [MIT](https://opensource.org/licenses/MIT)