<Meta title="快速上手" />

>Ark-CLI是一个实现快速生成项目模板、开发物料的脚手架及贡献ark物料库的脚手架<br/>
注意：node 版本不能低于10,项目路径不能包含中文字符


# 全局安装


```
npm install -g @syman/ark-cli

```

## 初始化项目指令

```
ark init

```
> 提示输入项目的名称。

选择项目模板:

```
1.【r3框架项目】    ========== 是基于r3框架搭建的vue项目，包含ark-ui和ark-ui-bcl

2.【ark-ui框架项目】 ======== 是预装了ark-ui组件库的vue项目

```



项目下载完毕后，可根据命令提示进入到项目根目录，使用npm start启动项目


## 贡献物料及物料文档指令




> 在项目根目录里执行<br/>
 **特别注意**：项目根目录里必须存在 package.json 文件

1. 执行下面指令，生成文档文件。

```
ark generate --doc
```

2. 本地启动文档服务，预览文档(类似于 vue 脚手架的 npm run serve、R3 框架的 npm start)

```
ark preview --doc
```

3. 打包编译文档项目

```
ark build --doc
```

4. 执行完打包命令后，方可使用下方命令发布文档到线上环境

```
ark oss --upload --doc
```

* 假如之前已经生成了文档模板，希望可以拉取最新的文档模板。需要在命令后追加--clear-cache参数。重新生成文档模板
```
ark generate --doc --clear-cache
```

## 查看阿里云oss上的cdn资源列表

```
ark oss --list
```
或者
```
ark oss --ls
```

