itoolbox-cli/README.md

iToolBox CLI 工具,用于创建扩展,打包扩展.

# iToolBox-Cli

iToolBox CLI 工具，用于创建扩展、配置、打包扩展项目。

[English](./README-EN.md)

## 命令

### 安装 CLI 工具

```shell
# npm 全局安装
> npm i itoolbox-cli -g
# cnpm 全局安装
> cnpm i itoolbox-cli -g
# yarn 全局安装
> yarn global add itoolbox-cli
```

### 查看版本

查看 cli 版本。

```shell
# 查看版本
> itoolbox -v
# 或
> itoolbox --version
```

### 查看帮助信息

查看帮助信息。

```shell
# 查看帮助
> itoolbox --help
```

### 通过模板创建一个新项目

下载线上模板到本地，本完成本地配置。

```shell
# 通过提供模板创建项目
> itoolbox -n
# 或
> itoolbox --new
```

### 配置项目扩展信息

此命令主要为非模板项目配置扩展的信息，如果使用模板生成则自动化完成配置信息，无需执行此命令。

可以使用该命令，配置任何项目。如果使用模板生成项目，也可以通过该命令修改扩展信息。

```shell
# 配置扩展基本信息
> itoolbox -c
# 或
> itoolbox --config
```

### 打包扩展

生成扩展相应的文件，打包 `dist` 目录中的文件，生成 `zip` 压缩包。

```shell
# 打包生成扩展压缩包
> itoolbox -p
# 或
> itoolbox --pack
```