# Dawn Cli
破晓检测 Cli 工具

## 快速开始

1. 准备需要的参数
a. 破晓 App Key
b. 发起检测的用户名（邮箱前缀）
c. OpenApi App Key
d. OpenApi Secret Key
e. 要检测的 url

2. 执行 Cli
用类似 `@pex/dawn-cli <命令> --<参数>="<值>"` 的形式，例如发起一次破晓兼容性检测：

   > pnpm dlx @pex/dawn-cli compatible \
       --check-url="<要检测的 url>" \
       --dawn-app-key="<破晓 App Key>" \
       --dawn-user-id="<发起检测的用户名>" \
       --open-api-app-key="<OpenApi App Key>" \
       --open-api-secret-key="<OpenApi Secret Key>"

   > 获取 AccessToken, env: prod
   > 创建检测任务
   > 创建检测任务成功(id: ...)，开始轮询任务状态
   > 第1次轮询, 任务(id: ...)还在检测中
   > 第2次轮询, 任务(id: ...)还在检测中
   > 第7次轮询, 检测任务(id: ...)成功
   > 截图: https:// ...

3. Enjoy~!

## API 参考

### 命令

Cli 会尝试从对应的环境变量中获取对应参数的值，通过 Cli 参数传递的值会覆盖环境变量中的值。
即 `--check-url="baidu.com"` 与 `CHECK_URL=baidu.com` 会有相同的效果。

#### Compatible

| 参数 | 环境变量名 | 类型 | 必填 | 默认值 | 说明 |
| ------------------- | ------------------- | ---------------------------------- | ---- | ------ | ----------------------------------------------------------------------------------------------- |
| check-url | CHECK_URL | `string` | ✅ | - | 要检测的 url |
| dawn-app-key | DAWN_APP_KEY | `string` | ✅ | - | 破晓的 App Key |
| dawn-user-id | DAWN_USER_ID | `string` | ✅ | - | 发起检测的用户名 |
| dawn-env | DAWN_ENV | `string`, 值为 `prod` 或 `staging` | ❎ | `prod` | 破晓以及 open api 的环境 |
| open-api-app-key | OPEN_API_APP_KEY | `string` | ✅ | - | OpenApi App Key |
| open-api-secret-key | OPEN_API_SECRET_KEY | `string` | ❎ | - | OpenApi Secret Key |
| open-api-domain | OPEN_API_DOMAIN | `string` | ❎ | - | OpenApi 的域名，默认会根据环境判断 |
| chrome-version | CHROME_VERSION | `number` | ❎ | 49 | 要检测的 Chrome 版本，目前支持 `40`, `49`, `61` |
| blank-page-selector | BLANK_PAGE_SELECTOR | `string` | ❎ | - | 破晓的白屏判断 selector， 如果设置了本选项，则 selector 匹配的元素没有出现在 dom 中就认为是白屏 |
| user-agent | USER_AGENT | `string` | ❎ | - | 检测时的 User Agent |
| login-unique | LOGIN_UNIQUE | `string` | ❎ | - | 破晓免登的 Token |