bukesiyi-cli 0.5.0 → 0.7.0
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 +54 -3
- package/dist/main.js +1866 -406
- package/package.json +3 -2
- package/skills/buke/SKILL.md +52 -0
package/README.md
CHANGED
|
@@ -28,10 +28,52 @@ buke web logout
|
|
|
28
28
|
|
|
29
29
|
`delivery.list` 需要 `kind` 和 `sourceId`,示例中的项目编号要换成自己的短剧项目编号。
|
|
30
30
|
|
|
31
|
-
登录密码使用隐藏终端输入、管道或 `BUKE_PASSWORD`,不写命令参数。`web operations --json` 返回固定操作编号、方法、路径、正文类型和适用限制。路径参数通过 `--params` JSON 文件提供,查询条件用 `--query`,正文用 `--data`;原文件上传用 `--file`,`multipart` 表单用 `--files` 指定真实字段名(如 `{"mask":"./mask.png"}`,单文件也可用 `--file`,按目录自动选择字段名);单文件按目录策略限制:图片 15 MiB、文档 30 MiB、允许音视频的附件 90 MiB
|
|
31
|
+
登录密码使用隐藏终端输入、管道或 `BUKE_PASSWORD`,不写命令参数。`web operations --json` 返回固定操作编号、方法、路径、正文类型和适用限制。路径参数通过 `--params` JSON 文件提供,查询条件用 `--query`,正文用 `--data`;原文件上传用 `--file`,`multipart` 表单用 `--files` 指定真实字段名(如 `{"mask":"./mask.png"}`,单文件也可用 `--file`,按目录自动选择字段名);单文件按目录策略限制:图片 15 MiB、文档 30 MiB、允许音视频的附件 90 MiB、短剧配音录音 20 MiB、语音转文字 2 MiB、蒙版 4 MiB;表单总量最多 256 MiB。业务头用 `--headers <JSON文件>`,仅允许目录声明的字段(如录音的 `X-Script-Fingerprint`),不能覆盖认证或工作区。下载用 `--out <新文件>`,已有文件不会覆盖。签发 API 密钥、分享链接和下载凭证必须指定 `--out`;真实响应只写入权限为 0600 的文件,终端输出脱敏结果。
|
|
32
32
|
|
|
33
33
|
网页写操作保留 `webRecovery` 与原请求键。已受理、结果未知和完成分别表示;连接中断后先查询原资源。只有服务端支持幂等重放的操作才能用原键恢复,不支持重放时不会把再次提交伪装成恢复。并发同一请求只提交一次;已完成后的独立串行操作仍可执行。上次结果仍未知时,明确创建另一次尝试须提供新键并再次确认范围。`web logout` 撤销网页会话;`buke logout` 仍只删除本机 API 密钥,不混用两种凭据。
|
|
34
34
|
|
|
35
|
+
### 短信登录与首次设密
|
|
36
|
+
|
|
37
|
+
先查询 `auth.smsLoginStatus`,确认服务开放后发送验证码。手机号和验证码通过私有 JSON 文件或 `--data -` 标准输入提供,勿把验证码、密码写进命令行。短信登录成功后,CLI 校验账号、工作区成员身份、令牌和有效期,将真实会话保存到权限为 0600 的会话文件;失败或不完整响应不会覆盖原会话。终端、`--out` 结果和恢复记录均隐藏验证码、密码及令牌。
|
|
38
|
+
|
|
39
|
+
```sh
|
|
40
|
+
buke web call auth.smsLoginStatus --json
|
|
41
|
+
buke web call auth.sendLoginSms --data phone.json --yes --json
|
|
42
|
+
buke web call auth.loginWithSms --data sms-login.json --yes --json
|
|
43
|
+
buke web whoami --json
|
|
44
|
+
buke web call auth.sendPasswordSetupSms --yes --json
|
|
45
|
+
buke web call auth.setupPassword --data first-password.json --yes --json
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
`phone.json` 使用 `phone` 字段;`sms-login.json` 使用 `phone`、`code`;`first-password.json` 使用 `code`、`newPassword`。首次设密仅适用于已登录且尚未设密的账号,验证码发送给当前账号绑定手机号,不签发新会话。一键登录依赖原生手机 SDK,CLI 不提供该入口。
|
|
49
|
+
|
|
50
|
+
### 图文、剪辑与语音入口
|
|
51
|
+
|
|
52
|
+
固定目录补齐以下网页能力,仍使用本人会话和工作区权限;写操作继续要求 `--yes`。
|
|
53
|
+
|
|
54
|
+
| 功能 | 操作编号与参数 |
|
|
55
|
+
| --- | --- |
|
|
56
|
+
| 图文引用素材库 | `graphic.attachGraphicRunAsset`:`--params` 提供 `runId`,`--data` 提供 `assetId` |
|
|
57
|
+
| 图文保存到素材库 | `graphic.saveGraphicImageToLibrary`:`--params` 提供 `runId`、`imageId`,`--data` 提供 `kind`(`character` / `scene` / `prop`)和可选 `name` |
|
|
58
|
+
| 图文原图 | `graphic.graphicImageSource`:`runId`、`imageId` |
|
|
59
|
+
| 商品视频素材原图 | `videos.commercialAdImageSource`:`rootRunId`、`assetId` |
|
|
60
|
+
| 商品视频故事板原图 | `videos.commercialAdStoryboardSource`:`rootRunId`、`imageKey` |
|
|
61
|
+
| 商品视频编辑原图 | `videos.commercialAdImageEditSource`:`rootRunId`、`editId` |
|
|
62
|
+
| 剪辑时间线 | `videos.getCommercialAdEditTimeline` 使用 `rootRunId`;`drama.getStoryEditTimeline` 使用 `projectId` |
|
|
63
|
+
| 语音转文字 | `speech.health` 查询服务状态;`speech.transcribe --file <音频> --yes` 提交录音 |
|
|
64
|
+
| 创建入口 | `public.publicCommercialAdInspirations` 查询公开创意参考;`videos.showcaseEntryDefault` 查询当前登录账号的默认设置 |
|
|
65
|
+
|
|
66
|
+
四种原图操作返回二进制原件,必须指定 `--out <新文件>`;原有 `download` 操作继续用于交付文件。下载拒绝未就绪的 JSON 响应,即使输出文件没有扩展名也一样。
|
|
67
|
+
|
|
68
|
+
```sh
|
|
69
|
+
buke web call graphic.graphicImageSource --params image-params.json --out ./source.png --json
|
|
70
|
+
buke web call videos.getCommercialAdEditTimeline --params video-params.json --json
|
|
71
|
+
buke web call speech.health --json
|
|
72
|
+
buke web call speech.transcribe --file ./recording.webm --yes --json
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
语音转文字直接上传原始音频字节,不接受 multipart 字段或 JSON 正文。支持 WAV、MP3、WebM、M4A / MP4、OGG / Opus、AAC、FLAC,最多 2 MiB;服务端校验实际音频内容及 0.5–60 秒时长。它与短剧配音录音上传使用不同限制。
|
|
76
|
+
|
|
35
77
|
## 安装
|
|
36
78
|
|
|
37
79
|
运行环境要求 Node.js 20 或更高版本。
|
|
@@ -44,7 +86,7 @@ npm install -g bukesiyi-cli
|
|
|
44
86
|
|
|
45
87
|
```console
|
|
46
88
|
$ buke --version
|
|
47
|
-
bukesiyi-cli/0.
|
|
89
|
+
bukesiyi-cli/0.7.0
|
|
48
90
|
```
|
|
49
91
|
|
|
50
92
|
也可使用 `npx bukesiyi-cli <命令>` 临时运行,例如 `npx bukesiyi-cli whoami`。
|
|
@@ -120,9 +162,11 @@ $ buke login bk_test_0123456789abcdef_……
|
|
|
120
162
|
| `buke drama` | 短剧创作、剧本和分镜、人物与场景绑定、规格、报价、重拍、选版和交付 |
|
|
121
163
|
| `buke series list / show / create / episode-create` | 查询剧集、关联首集、创建续集 |
|
|
122
164
|
| `buke graphic` | 图文方案、报价生成、局部修改、版本管理和下载 |
|
|
165
|
+
| `buke shorts|videos|drama|graphic result` | 一条命令查状态并取件:已交付就下载,未交付说明下一步;支持 `--wait` |
|
|
123
166
|
| `buke library list / search / show / rename / archive / restore` | 统一查询和管理作品;以返回的 `archivable` 为准 |
|
|
124
167
|
| `buke assets list / search / show / upload / rename / archive / restore` | 查询平台、个人及上传素材,上传文件并管理个人素材 |
|
|
125
168
|
| `buke --version` | 输出版本号 |
|
|
169
|
+
| `buke update` | 通过 npm 自更新到最新版;启动时的版本提示可用 `BUKE_DISABLE_UPDATE_CHECK` 关闭 |
|
|
126
170
|
| `buke --help`、`buke <命令> --help` | 输出命令及选项帮助 |
|
|
127
171
|
|
|
128
172
|
写操作支持 `--idempotency-key <键>`。未指定时,CLI 自动生成并在结果中返回。重试同一操作必须保留原键和请求内容;新键表示新尝试,可能产生新订单及费用。模板短片的报价哈希与幂等键绑定,`shorts quote` 和 `shorts order` 必须使用相同键。
|
|
@@ -143,6 +187,10 @@ $ buke login bk_test_0123456789abcdef_……
|
|
|
143
187
|
|
|
144
188
|
`drama create` 支持 `--model` 和 `--resolution`。未显式指定模型时,报价前可适配人物参考;显式指定不兼容模型时进入需要处理的状态,不自动替换。`drama quote` 展示实际制作规格、费用及适配说明。
|
|
145
189
|
|
|
190
|
+
四条创作线的 `result` 子命令把查询和取件合成一步:查一次状态,已交付就直接下载(缺省名 `drama-<编号>.mp4` 等,图文进 `--out` 目录,缺省 `graphic-<编号>/`),失败或取消按 9 退出;`--wait` 沿用对应线 status 的等待语义(超时 8、失败或取消 9、停靠态 0)。短剧、商品视频、图文与短剧的提交类和查询类命令,可读输出带一行「网页查看」、`--json` 顶层带 `webLink` 字段,可在浏览器直接打开原任务;短剧模板短片无对应网页,不返回该字段。
|
|
191
|
+
|
|
192
|
+
启动时 CLI 检查 npm 上的最新版本(2 秒封顶、失败静默、结果缓存 24 小时),有新版时在标准错误提示;设 `BUKE_DISABLE_UPDATE_CHECK` 为非空值可关闭。`buke update` 等价于 `npm install -g bukesiyi-cli@latest`,失败退出 5 并给出手动命令。
|
|
193
|
+
|
|
146
194
|
短剧普通状态 JSON 可包含 `order.productionCompatibility` 和 `order.failures`。等待终态失败时,失败数组位于 JSON 顶层 `failures`,与 `error`、`recovery` 并列。素材定位不可确认时返回 `reference: null`,不推测具体图片;旧记录不会自动补齐证据。修正素材或通过 `drama spec` 明确修改规格后,须重新报价和确认,CLI 不自动切换模型或付费重试。
|
|
147
195
|
|
|
148
196
|
## 创作与管理示例
|
|
@@ -227,13 +275,15 @@ $ buke whoami --json
|
|
|
227
275
|
| `BUKE_API_KEY` | 优先使用的 API 密钥;设置后不读取本机凭据文件。`login` 验证后将其保存至本机 |
|
|
228
276
|
| `BUKE_BASE_URL` | 服务源地址。`--base-url` 优先于该变量;未配置时使用 `https://buke41.com` |
|
|
229
277
|
| `BUKE_CONFIG_DIR` | 凭据目录,须为绝对路径,支持展开开头的 `~`。默认依次采用 `$XDG_CONFIG_HOME/buke`、`~/.config/buke`;Windows 使用 `%APPDATA%\buke` |
|
|
278
|
+
| `BUKE_DISABLE_KEYCHAIN` | 设为 `1` 即强制把密钥存进 0600 凭据文件,不读写 macOS 登录钥匙串;Windows/Linux 本就不使用钥匙串 |
|
|
279
|
+
| `BUKE_DISABLE_UPDATE_CHECK` | 设为非空值即关闭启动时的版本检查(不联网、不提示);`buke update` 不受影响 |
|
|
230
280
|
| `BUKE_PASSWORD` | 网页会话登录密码;只在登录时使用,可改用隐藏终端输入 |
|
|
231
281
|
| `BUKE_SESSION_TOKEN` | 受控环境提供的真实网页会话令牌;不能使用 API 密钥 |
|
|
232
282
|
| `BUKE_WORKSPACE_ID` | 网页会话工作区;`--workspace` 优先,调用前核对真实成员身份 |
|
|
233
283
|
|
|
234
284
|
网页会话额外支持 `BUKE_PASSWORD`(仅登录时读取)、`BUKE_SESSION_TOKEN`(受控环境提供真实会话)和 `BUKE_WORKSPACE_ID`(工作区,显式 `--workspace` 优先并核对成员身份)。
|
|
235
285
|
|
|
236
|
-
API 密钥保存在 `credentials.json`,网页会话保存在同目录的 `session.json`。macOS 和 Linux 上文件权限仅允许当前用户读写。文件包含明文凭据,不得提交至代码仓库、写入镜像或直接共享。
|
|
286
|
+
API 密钥保存在 `credentials.json`,网页会话保存在同目录的 `session.json`。macOS 和 Linux 上文件权限仅允许当前用户读写。文件包含明文凭据,不得提交至代码仓库、写入镜像或直接共享。macOS 上 `login` 优先把密钥存进登录钥匙串(`bukesiyi-cli/api-key`)并删除明文文件,钥匙串不可用时才落 0600 文件;设 `BUKE_DISABLE_KEYCHAIN=1` 可强制用文件。写入钥匙串时密钥会短暂出现在 `security` 命令行参数上,介意者可改用 `BUKE_API_KEY` 环境变量。
|
|
237
287
|
|
|
238
288
|
启用 Node.js 环境代理时,CLI 会拒绝可能经代理传输密钥的本机 HTTP 请求。本机调试可通过 `NO_PROXY` 排除回环地址:
|
|
239
289
|
|
|
@@ -278,6 +328,7 @@ export NO_PROXY='localhost,127.0.0.1,[::1]'
|
|
|
278
328
|
| `CLI_CREDENTIALS_WRITE_FAILED` | 5 | 无法保存或删除凭据。修正目录权限,或通过 `BUKE_CONFIG_DIR` 指定可写目录 |
|
|
279
329
|
| `CLI_NETWORK` | 5 | 网络连接失败。检查地址、网络、代理和证书;确认配置正确后有限重试 |
|
|
280
330
|
| `CLI_TIMEOUT` | 5 | 请求超过时限;JSON 请求默认 15 秒、成片下载默认 120 秒。检查网络或代理;涉及提交时先核对原请求结果 |
|
|
331
|
+
| `CLI_UPDATE_FAILED` | 5 | `buke update` 未完成自动更新。按错误消息里的手动命令运行 `npm install -g bukesiyi-cli@latest`;网络或权限恢复后可重试 |
|
|
281
332
|
| `CLI_REDIRECT` | 5 | 目标服务返回重定向,CLI 未跟随。核对服务源地址后重新登录 |
|
|
282
333
|
| `CLI_BAD_RESPONSE` | 5 | 响应不符合 API 结构。检查服务地址、代理或网关;仅对可重试状态采用有限退避 |
|
|
283
334
|
| `CLI_DOWNLOAD_NOT_READY` | 7 | 下载接口返回 HTTP 202,文件尚未就绪。查询原任务后再次下载;CLI 不保存响应为成片、不自动重试,也不重新生成 |
|