futu-cli/readme.md

A simple CLI for scaffolding futu5_ipo projects.

# Futu5 业务 node.js 接入层脚手架


## 安装

```bash
npm install -g futu-cli
```

## 使用


```bash
futu init <project-name>
```

例：

```bash
futu init my-project
```

上面的命令将从[官方模板仓库](http://gitlab.futunn.com/irvingliang/futu5_template)拉取模板，提示输入交互信息，然后生成目标项目 `./my-project`。

安装指定模板的 `1.0` 分支：

```bash
futu init my-project -v 1.0
```

使用第三方模板：

```bash
futu init my-project -t ./other_template
```

## options

```bash
# 使用其他模板，默认使用官方模板
-t, --template

# 使用指定分支
-v, --template-version

# 使用 git clone 方式下载模版，默认 http
-c, --clone

# 输出帮助信息
-h, --help
```

## 官方模板

目前可用模板：

* [`futu5_template`](http://gitlab.futunn.com/irvingliang/futu5_template) - 含 Futu5--Node.js 接入层基础目录结构。

## 自定义模板

模板可能不能满足所有使用者的要求，此时可以[编写自定义模板](./docs/如何写自定义模板.md)。

## 环境

> `"node": ">=6.0.0"`

## 其他

* [脚手架代码结构说明](./docs/futu-cli 代码结构说明.md)
* [原脚手架方案](./docs/futu5 node.js 接入层脚手架技术方案_v4.pdf)