bukesiyi-cli 0.3.2 → 0.4.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.
Files changed (3) hide show
  1. package/README.md +41 -7
  2. package/dist/main.js +1066 -142
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  ## 支持范围与接入条件
6
6
 
7
- - 支持 API 凭据管理、产品建档、余额查询,以及渲染短片、商品视频和短剧的创建、查询、确认与下载。
7
+ - 支持 API 凭据管理、产品和素材管理、余额查询,以及渲染短片、商品视频、短剧和图文的创作、确认与交付。
8
8
  - 注册账号无需单独申请 API 访问资格。调用要求 API 服务启用、密钥有效,且账号在密钥所属团队具有制作权限。
9
9
  - 密钥由账号本人在[API 密钥页面](https://buke41.com/account/api-keys)创建、查看和吊销。完整密钥仅在创建成功时显示一次。
10
10
  - 示例使用演示凭据、路径和编号。执行时替换为当前环境配置;程序应解析 JSON 字段,不应逐字匹配中文输出。
@@ -21,7 +21,7 @@ npm install -g bukesiyi-cli
21
21
 
22
22
  ```console
23
23
  $ buke --version
24
- bukesiyi-cli/0.3.2
24
+ bukesiyi-cli/0.4.0
25
25
  ```
26
26
 
27
27
  也可使用 `npx bukesiyi-cli <命令>` 临时运行,例如 `npx bukesiyi-cli whoami`。
@@ -91,10 +91,14 @@ $ buke login bk_test_0123456789abcdef_……
91
91
  | `buke whoami` | 查询密钥归属、团队、权限及有效期。优先使用 `BUKE_API_KEY`,否则读取本机凭据 |
92
92
  | `buke logout` | 删除本机凭据,不发送网络请求,不吊销密钥 |
93
93
  | `buke balance` | 查询可用、冻结及已使用额度 |
94
- | `buke products create / set-images / confirm-lock` | 创建产品、上传商品图片、确认外观信息 |
94
+ | `buke products list / search / show / create / update / archive / restore / set-images / confirm-lock` | 查询和管理产品、上传图片、确认外观信息 |
95
95
  | `buke shorts catalog / upload / quote / order / status / download / cancel` | 查询模板、上传素材、报价、创建订单、查询进度、下载和取消 |
96
- | `buke videos create / status / message / confirm / download` | 创建商品视频任务、查询进度、发送消息、确认制作和下载 |
97
- | `buke drama create / status / quote / confirm / cancel / download` | 创建短剧订单、查询进度、报价、确认制作、取消和下载 |
96
+ | `buke videos create / status / message / confirm / versions / download / cancel` | 创作商品视频,提交附件和选项,确认制作并下载指定版本 |
97
+ | `buke drama` | 短剧创作、剧本和分镜、人物与场景绑定、规格、报价、重拍、选版和交付 |
98
+ | `buke series list / show / create / episode-create` | 查询剧集、关联首集、创建续集 |
99
+ | `buke graphic` | 图文方案、报价生成、局部修改、版本管理和下载 |
100
+ | `buke library list / search / show / rename / archive / restore` | 统一查询和管理作品;以返回的 `archivable` 为准 |
101
+ | `buke assets list / search / show / upload / rename / archive / restore` | 查询平台、个人及上传素材,上传文件并管理个人素材 |
98
102
  | `buke --version` | 输出版本号 |
99
103
  | `buke --help`、`buke <命令> --help` | 输出命令及选项帮助 |
100
104
 
@@ -108,14 +112,43 @@ $ buke login bk_test_0123456789abcdef_……
108
112
 
109
113
  `drama confirm` 失败时同样保留目标订单、最后一次成功查询的状态和已知幂等键,并返回 `operation: "confirm"`。`operationOutcome` 区分 `not_submitted`(确认请求尚未发送)、`rejected`(服务端明确拒绝)和 `unknown`(受理结果未知)。`acceptance` 仅表示原订单是否已确认存在,不表示本次费用确认成功。CLI 不自动重发确认请求;结果未知时应先查询原订单并保留原键。
110
114
 
115
+ 新增的导演确认、重拍、剧集和附件写入同样保留可用的原请求键及查询入口。导演卡确认结果未知时,`recovery.confirmation` 保留原 `kind` 与 `confirmationId`,可在查询原任务后配合原键显式重放;CLI 不自动重发。
116
+
111
117
  提交结果不明时,`recovery.acceptance` 为 `unknown`,不返回虚构的任务编号。保存原幂等键,在 Studio 核对原请求;不得换键重新下单。CLI 不自动重试。
112
118
 
113
119
  `drama create` 支持 `--model` 和 `--resolution`。未显式指定模型时,报价前可适配人物参考;显式指定不兼容模型时进入需要处理的状态,不自动替换。`drama quote` 展示实际制作规格、费用及适配说明。
114
120
 
115
- 短剧普通状态 JSON 可包含 `order.productionCompatibility` 和 `order.failures`。等待终态失败时,失败数组位于 JSON 顶层 `failures`,与 `error`、`recovery` 并列。素材定位不可确认时返回 `reference: null`,不推测具体图片;旧记录不会自动补齐证据。修正素材或在 Studio 明确修改规格后,须重新报价和确认,CLI 不自动切换模型或付费重试。
121
+ 短剧普通状态 JSON 可包含 `order.productionCompatibility` 和 `order.failures`。等待终态失败时,失败数组位于 JSON 顶层 `failures`,与 `error`、`recovery` 并列。素材定位不可确认时返回 `reference: null`,不推测具体图片;旧记录不会自动补齐证据。修正素材或通过 `drama spec` 明确修改规格后,须重新报价和确认,CLI 不自动切换模型或付费重试。
122
+
123
+ ## 创作与管理示例
124
+
125
+ 完整参数见[CLI 参考](https://buke41.com/developers/cli)。`--data <文件|->` 读取 JSON 对象;`-` 表示标准输入。调用方身份及工作区由密钥确定,不能通过 JSON 覆盖。
126
+
127
+ ```sh
128
+ buke products search --q "夏装" --limit 20 --json
129
+ buke library list --kind graphic --limit 20 --json
130
+ buke assets list --source platform --kind character --json
131
+ buke assets upload ./reference.png --authorization own --license "本公司自有素材" --json
132
+ buke graphic create --text "为夏季新品准备三张商品介绍图" --json
133
+ buke graphic status <图文项目编号> --wait --json
134
+ buke graphic quote <图文项目编号> --json
135
+ buke graphic generate <图文项目编号> --quote-hash <报价哈希> --yes --wait --json
136
+ buke graphic download <图文项目编号> --all --out ./images
137
+ buke drama context <短剧编号> --json
138
+ buke drama spec <短剧编号> --expected-epoch <当前版本> --model <模型> --resolution <分辨率>
139
+ buke drama versions <短剧编号> --json
140
+ buke videos versions <视频编号> --json
141
+ buke videos download <视频编号> --production-id <制作版本编号> --out ./video.mp4
142
+ ```
143
+
144
+ 普通创作消息用于调整要求和方案,不自动授权生成。图文 `generate --yes`、短剧 `confirm --yes` / `director-confirm --yes` / `redo --yes`、商品视频 `confirm --yes`、配乐 `music-compose --yes` 分别确认服务端当前报价或确认卡。改稿、改规格和更换素材可能使旧报价失效,应重新查询。指定已完成镜头重拍属于新制作,按新报价收费;原版本保留。
145
+
146
+ 产品资料更新支持名称;图片和外观信息使用各自命令。平台素材只读,个人生成素材可重命名、归档和恢复。图文作品当前不支持归档;作品接口通过 `archivable: false` 表明此限制。归档不会删除已生成文件或已有订单引用。
116
147
 
117
148
  ## 输出与通用选项
118
149
 
150
+ 完整成片下载只接受 HTTP 200、非空正文及合法视频类型;短剧和渲染短片为 MP4,商品视频同时兼容服务端返回的 QuickTime。HTTP 202 表示文件尚未就绪,命令退出 7,不保存响应或覆盖已有文件。应查询原任务后再次下载,不重新生成。
151
+
119
152
  | 选项 | 作用 |
120
153
  | --- | --- |
121
154
  | `--json` | 标准输出仅包含一个 JSON 文档:成功时为结果,失败时为结构化错误。适用于脚本和 AI agent |
@@ -214,9 +247,10 @@ export NO_PROXY='localhost,127.0.0.1,[::1]'
214
247
  | `CLI_CREDENTIALS_UNREADABLE` | 5 | 凭据文件损坏、类型不符或权限不足。修正权限,或删除本机凭据后重新登录 |
215
248
  | `CLI_CREDENTIALS_WRITE_FAILED` | 5 | 无法保存或删除凭据。修正目录权限,或通过 `BUKE_CONFIG_DIR` 指定可写目录 |
216
249
  | `CLI_NETWORK` | 5 | 网络连接失败。检查地址、网络、代理和证书;确认配置正确后有限重试 |
217
- | `CLI_TIMEOUT` | 5 | 单次请求超过 15 秒。检查网络或代理;涉及提交时先核对原请求结果 |
250
+ | `CLI_TIMEOUT` | 5 | 请求超过时限;JSON 请求默认 15 秒、成片下载默认 120 秒。检查网络或代理;涉及提交时先核对原请求结果 |
218
251
  | `CLI_REDIRECT` | 5 | 目标服务返回重定向,CLI 未跟随。核对服务源地址后重新登录 |
219
252
  | `CLI_BAD_RESPONSE` | 5 | 响应不符合 API 结构。检查服务地址、代理或网关;仅对可重试状态采用有限退避 |
253
+ | `CLI_DOWNLOAD_NOT_READY` | 7 | 下载接口返回 HTTP 202,文件尚未就绪。查询原任务后再次下载;CLI 不保存响应为成片、不自动重试,也不重新生成 |
220
254
  | `CLI_WAIT_TIMEOUT` | 8 | 等待达到时限,任务并未因此失败。按 `recovery.statusCommand` 查询原任务,不重新下单 |
221
255
  | `CLI_TASK_FAILED` | 9 | 原任务进入失败或取消终态。查询原任务,核对原因、已完成内容及计费;新制作需要重新报价和授权 |
222
256
  | `CLI_INTERRUPTED` | 130 | 进程收到中断信号。SIGTERM 和 SIGHUP 分别退出 143、129;提交被中断时先核对原任务 |