bukesiyi-cli 0.1.3 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -8
- package/dist/main.js +1963 -99
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,7 +8,7 @@ API 调用是《不可思议》给程序用的入口：你的脚本、流水线
|
|
|
8
8
|
|
|
9
9
|
装之前先看这几条：
|
|
10
10
|
|
|
11
|
-
-
|
|
11
|
+
- **这一版能下单、查进度、下载成片**，覆盖三条产线：渲染短片（`buke shorts …`）、商品视频（`buke videos …`）和短剧（`buke drama …`），另有产品建档（`buke products …`）和余额（`buke balance`）。登录三件套（`buke login`、`buke whoami`、`buke logout`）负责把一把 API 密钥登录并稳妥地保存在本机。
|
|
12
12
|
- **注册账号都能用。** 登录《不可思议》后自己创建密钥，不用另外申请；遇到问题可以联系客服（联系方式见文末「联系我们」）。
|
|
13
13
|
- **密钥在网页上创建，不在这个工具里。** 账号本人登录《不可思议》，在右上角头像菜单的「账号设置」里打开「API 密钥」，在那里创建、查看和吊销：<https://buke41.com/account/api-keys>。完整密钥只在创建成功的那一刻显示一次。
|
|
14
14
|
|
|
@@ -26,7 +26,7 @@ npm install -g bukesiyi-cli
|
|
|
26
26
|
|
|
27
27
|
```console
|
|
28
28
|
$ buke --version
|
|
29
|
-
bukesiyi-cli/0.1
|
|
29
|
+
bukesiyi-cli/0.3.1
|
|
30
30
|
```
|
|
31
31
|
|
|
32
32
|
不想全局安装时，可以用 npx 临时运行，写法是 `npx bukesiyi-cli <命令>`，例如 `npx bukesiyi-cli whoami`。下面的例子都直接写 `buke`。
|
|
@@ -95,9 +95,20 @@ $ buke login bk_test_0123456789abcdef_……
|
|
|
95
95
|
| `buke login` | 取密钥、向服务端确认它可用，然后保存到本机。密钥依次从环境变量 `BUKE_API_KEY`、标准输入、终端粘贴里取 |
|
|
96
96
|
| `buke whoami` | 显示当前这把密钥是谁的、属于哪个团队、权限范围是什么、什么时候到期。设了 `BUKE_API_KEY` 就用它，否则用本机保存的 |
|
|
97
97
|
| `buke logout` | 删除本机保存的密钥。不联网，也不会吊销密钥 |
|
|
98
|
+
| `buke balance` | 查询账户余额：可用多少、冻着多少、已经花了多少 |
|
|
99
|
+
| `buke products create / set-images / confirm-lock` | 产品建档：建一件产品、传产品图、确认外观锁（颜色、廓形、材质）。商品视频下单的前置 |
|
|
100
|
+
| `buke shorts catalog / upload / quote / order / status / download / cancel` | 渲染短片：列模板、托管素材图、报价、下单、查进度、下载成片、取消 |
|
|
101
|
+
| `buke videos create / status / message / confirm / download` | 商品视频：下单、查进度、给导演回话、确认开拍、下载成片 |
|
|
102
|
+
| `buke drama create / status / quote / confirm / cancel / download` | 短剧：下单、查进度（查询本身会推进写稿与排版）、报价、确认开拍、取消、下载成片 |
|
|
98
103
|
| `buke --version` | 显示版本 |
|
|
99
104
|
| `buke --help`、`buke <命令> --help` | 显示用法 |
|
|
100
105
|
|
|
106
|
+
写命令（下单、传图、确认、取消）都支持 `--idempotency-key <键>`：不给时自动生成一个并在输出里回显，网络重试时原样复用同一把，服务端按同键同内容回放、不会重复扣费。渲染短片的报价哈希与幂等键绑定：`buke shorts quote` 回的 `--quote-hash`，下单时要配同一把 `--idempotency-key` 才对得上。`buke shorts order --wait` 和 `buke videos status --wait` 会轮询到终态：成功退出 0，任务失败退出 9，到 `--timeout`（默认 600 秒）还在跑退出 8。
|
|
107
|
+
|
|
108
|
+
短剧的确认开拍（`buke drama confirm`）要先取一次当前报价摆出来给人看：不加 `--yes` 只看，退出码 2；加了 `--yes` 才提交这笔布支出，并且用服务端认可的报价哈希核对，报价变过就不会扣费。`buke drama status --wait` 会在终态或停靠时停下：拿到成片退出 0；失败、取消退出 9；停在「要人处理」或「有镜没拍成、可补拍」时退出 0，输出里带原因、缺口与下一步。
|
|
109
|
+
|
|
110
|
+
等待失败、超时或轮询断网时，先查询原任务。`--json` 错误文档的 `recovery` 保留任务编号、最后状态及查询命令；`shorts order` 还保留本次幂等键。自定义服务的查询命令会带回原来的 `--base-url`。若提交结果还无法确认，`recovery.acceptance` 为 `unknown`，只保留请求的键和服务地址，不虚构已受理或任务编号。先在 Studio 核对原请求，不要换键重新下单；CLI 不会自动重试。
|
|
111
|
+
|
|
101
112
|
通用选项：
|
|
102
113
|
|
|
103
114
|
| 选项 | 作用 |
|
|
@@ -167,12 +178,12 @@ export NO_PROXY='localhost,127.0.0.1,[::1]'
|
|
|
167
178
|
| 0 | 成功 | 会 |
|
|
168
179
|
| 2 | 参数或用法不对 | 会 |
|
|
169
180
|
| 3 | 没有登录，或者密钥、账号现在不能用 | 会 |
|
|
170
|
-
| 4 | 余额不足 |
|
|
181
|
+
| 4 | 余额不足 | 会 |
|
|
171
182
|
| 5 | 服务端、网络或本机出错 | 会 |
|
|
172
|
-
| 6 | 报价变了 |
|
|
173
|
-
| 7 |
|
|
174
|
-
| 8 | 等待超时 |
|
|
175
|
-
| 9 | 任务失败 |
|
|
183
|
+
| 6 | 报价变了 | 会 |
|
|
184
|
+
| 7 | 请求太频繁，请稍后再试；或这一步还没到时候，稍后再来 | 会 |
|
|
185
|
+
| 8 | 等待超时 | 会 |
|
|
186
|
+
| 9 | 任务失败 | 会 |
|
|
176
187
|
| 10 | 要找的东西不存在 | 会 |
|
|
177
188
|
| 130 | 被 Ctrl-C 打断 | 会 |
|
|
178
189
|
|
|
@@ -184,7 +195,7 @@ export NO_PROXY='localhost,127.0.0.1,[::1]'
|
|
|
184
195
|
|
|
185
196
|
出错时，给人看的输出里有一行「（错误码 …）」；加了 `--json` 时，错误码在 `error.code` 里。错误码有两类：
|
|
186
197
|
|
|
187
|
-
- `OPEN_API_` 开头的是服务端回的：请求送到了，服务端没有接受。报错的第一行是服务端的原话，写明了原因和该怎么办；这类报错带一个请求编号（`--json` 里是 `error.traceId`），联系客服时把它一起给出。退出码按上面那张表：密钥或账号现在不能用是 3
|
|
198
|
+
- `OPEN_API_` 开头的是服务端回的：请求送到了，服务端没有接受。报错的第一行是服务端的原话，写明了原因和该怎么办；这类报错带一个请求编号（`--json` 里是 `error.traceId`），联系客服时把它一起给出。退出码按上面那张表：密钥或账号现在不能用是 3，余额不足是 4，报价变了是 6，请求太频繁或这一步还没到时候是 7，这个地址上没有接口或要找的东西不存在是 10，服务端出错是 5。
|
|
188
199
|
- `CLI_` 开头的是这个工具自己发现的问题：命令的写法、密钥的给法、服务地址、本机的凭据文件、网络。这一版一共有下面这些：
|
|
189
200
|
|
|
190
201
|
| 错误码 | 退出码 | 怎么办 |
|
|
@@ -204,6 +215,8 @@ export NO_PROXY='localhost,127.0.0.1,[::1]'
|
|
|
204
215
|
| `CLI_TIMEOUT` | 5 | 等了 15 秒，服务端没有回完。稍后重试；总是超时就检查网络，或者中间有没有代理、防火墙拦着 |
|
|
205
216
|
| `CLI_REDIRECT` | 5 | 服务器要求跳转到别处；为了不把密钥带过去，没有跟随。核对服务地址（报错的括号里是跳转指向的地方），用正确的地址重新登录 |
|
|
206
217
|
| `CLI_BAD_RESPONSE` | 5 | 收到的回应不是约定的格式，多半是中间的网关或别的网站回的，括号里是 HTTP 状态码。状态码是 429 或 5xx 时稍后重试；其余的先核对服务地址，重试多半没有用 |
|
|
218
|
+
| `CLI_WAIT_TIMEOUT` | 8 | `--wait` 等到时限任务还在跑，任务本身没有失败。按恢复信息查询原任务，给查询加 `--wait --timeout <秒数>` 继续等待，不要重新下单 |
|
|
219
|
+
| `CLI_TASK_FAILED` | 9 | 原任务到了失败的终态，话里是服务端记的原因。先按恢复信息查询原任务并核对原因、已完成内容和账目；新制作需要另行报价与授权 |
|
|
207
220
|
| `CLI_INTERRUPTED` | 130 | 命令被打断了：按了 Ctrl-C，或者收到了 SIGTERM、SIGHUP（这两种的退出码是 143、129）。需要时重新运行 |
|
|
208
221
|
| `CLI_INTERNAL` | 5 | 工具自己出了没有料到的错，正常使用不应该遇到。把完整的报错和运行的命令（不要带密钥）发给客服，联系方式见文末「联系我们」 |
|
|
209
222
|
|