egret-cli/README.md

EGRET-CLI
================================================
Current Version: v0.0.6

new egret command-line interface base on npm.
基于npm的新白鹭引擎命令行

quicker,more efficient and smaller,easy to extend.  
更快，更高效，更小巧并且易于扩展

Experimental Project
实验性项目

Developed by Egret Technology

Prepare:
--------------------

    step1. install egret engine v3.1.4(or later)
    step2. install node and npm(with node)

Usage:
--------------------

```
npm install -g egret-cli
```

#1. Nest示例工程(web)

##1.1 create 创建命令

```
egret-cli nest create [relativePathToCwd] | -p <absolutePath>
```
参数说明:
    [relativePathToCwd]       要创建项目的相对路径(相对于当前执行目录)
    -p, --path <absolutePath> 要创建的项目的绝对路径(必须指定-p 否则会当做相对路径处理)

##1.2 run 运行命令

```
egret-cli nest run [relativePathToCwd | -p <absolutePath>] [-a]
```

用法示例:

```
egret-cli nest run
egret-cli nest run -a
egret-cli nest run test -a
egret-cli nest run -p /Users/testuser/test -a 
```

可选参数说明:
    relativePathToCwd         要执行项目的相对路径
    -p, --path <absolutePath> 要执行的项目的绝对路径(必须指定-p)
    -a, --autoBuild           打开自动编译

##1.3 set 设置运行参数

在当前目录执行，默认运行参数为测试参数,具体游戏参数需要向开放平台申请 详询 http://open.egret.com/Wiki

```
egret-cli nest set [options]
```
可选参数说明:
    --appId <appId>               游戏id,必传 原始值88888
    --channelId <channelId>       渠道id,必传 原始值9166
    --platInfo [platInfo]         平台信息,可选 默认值为open_<appId>_<channelId>
    --spId [spId]                 spId,可选 默认值为<channelId>
    --sdkDomain [sdkDomain]       可选,默认值为 http://api.egret-labs.org/v2
    --serverDomain [serverDomain] 可选,默认值为 http://api.egret-labs.org/v2

#2.native工程
运行支持nest的android-support工程，你需要下载 https://github.com/egret-labs/egret-android-support/tree/refactor-for-nest

创建android工程以前需要配置android-sdk参数
##2.1 config 命令配置全局参数
config set 设置参数

```
egret-cli config set --key <keyName> --value <valueName>
```
config get 查看参数

```
egret-cli config get --key <keyName>

参照如下方式配置你自己的android-sdk和android_support目录：

```
egret-cli config set --key android-sdk --value "/Users/testuser/Application Support/sdk"
```

```
egret-cli config set --key android_support --value /Downloads/egret_android_support
```

##2.2 配置egret.config
配置在要生成android sdk工程的对应egret工程内(本例中即生成的nest工程)的配置文件
手动配置以下参数(也可以在命令行中输入,区别在于后者每次部署都需要输入一遍参数)
{
	"androidProjectPath":"../TESTAPUSV112",//相对于egret工程的相对路径
	"packageName":"com.jack.testapusv112",//要生成的android工程包名
	"sdk":"apus"//可选的sdk种类 目前仅支持国内渠道的quicksdk和apus
}
##2.3 native create 
###android工程创建
Usage:

```
    egret-cli native create <egretH5path> [options]
```
    <egretH5path>                           h5工程目录
  Options:                           
    -h, --help                              帮助
    -p, --androidProjectPath <projectName>  要生成的android工程目录
    -n, --packageName <packageName>         android包名
    -s, --sdk <quicksdk | apus>             sdk种类，可选quicksdk国内渠道，apus海外渠道
```
##2.4 native deploy 
###android工程部署

Usage:

```
    egret-cli native create <egretH5path> [options]
```
    <egretH5path>                           h5工程目录
  Options:                           
    -h, --help                              帮助
    --platform <ios|android>                平台类型 目前只有android
    -p, --androidProjectPath <projectName>  要生成的android工程目录
    -s, --sdk <quicksdk | apus>             sdk种类，可选quicksdk国内渠道，apus海外渠道
##2.5 native public
###android工程发布

暂时无法使用