@clipwright/cli

中文文档
0.47.0发布于 2026/11/09MITES Module近 30 天下载 4186

Clipwright UGC 视频 API 的命令行客户端

中文使用文档
文档目录3 节
  1. 工作流程文件和明确采购
  2. 原生视频命令
  3. 更改日志

校对:soup

命令行客户端 剪贴笔 UGC 和无相 aPI视频.

export CLIPWRIGHT_API_KEY=cw_...

npx -y -p @clipwright/cli clipwright quote --script "Hello from Clipwright."
npx -y -p @clipwright/cli clipwright make  --script "Hello from Clipwright."

软件包在两个名字下安装相同的程序, clipwright 财务报告和审定财务报表 clipwright-cli。一个不相关的 npm 软件包也叫 clipwright 二进制 在短名下,所以安装两个 在一个项目中只留下一个 node_modules/.bin - 默默无声 使用 clipwright-cli 这很重要 命令 上方的软件包名称 -p所以不管怎样他们都会在这里解决的.

食人鱼,每个提示 一个代理 变成视频,它发出的电话 价钱,在 @clipwright/mcp-server 读取。 。 。 .

命令它会做什么
quote --script <text>估计信贷成本。 无所费用.
make --script <text>编出一段等. 费用入帐. 打印视频 URL 到 stdout, 进度和警告到 stderr .
upload <path>上传本地 PNG/JPEG 并打印 https url 以通过 --image免费的.
runs <id>打印一个运行状态.
feedback --kind <kind> --text <text>告诉我们什么是缺失的,令人困惑的,错误的或缓慢的; --run <id> 说出它的运行。 我们每个都读过 免费.
voices列出声音 --voice 打开 make: 预设,声音 gemini-3.8-flash-tts,然后是目录. --skill make_faceless 列出用于 make-faceless 换句话说 缩小范围 --language, (中文(简体) ), --gender, (中文(简体) ), --age, (中文(简体) ), --use-case 财务报告和审定财务报表 --model免费的.
actors列出账户可以使用的演员: Clipwright 目录和您自己的目录。 免费.
quote-actor估计个人演员的成本. 无所费用.
create-actor从描述创建个人演员. 费用贷项 ——按要求格式收费. 打印运行;跟着它 runs <id>。 。 。 .
quote-faceless估计无相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相 无所费用.
make-faceless开始一个无相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相. 费用入帐. 打印运行;跟着它 runs <id>。 。 。 .
delete-actor <id>删除此账户的个人角色。 已经录下来的视频 保持原样 免费.
shots <run>列出完成的视频的镜头:长度、类型、描述的开始以及每个视频的预览链接。 免费.
edit-show <run>打印运行的编辑草稿为 JSON。 0版本表示没有被存储. 免费.
edit-save <run> --file <path>从文件中保存草稿 edit-show 已打印过。 不收费,不收费.
revise-quote <run>定价修改一则无相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相 无所费用.
revise <run>开始一个修改:一个新的运行,使视频与你改变的镜头再次相接. 费用入帐. 打印运行;跟着它 runs <id>。 。 。 .
candidate-quote <run>定价一个被选手,一幅相片或一幅相片,并打印出引文为JSON. 无所费用.
candidate <run>打印被选中候选人的引文 --yes 来了. 费用入帐. 打印运行;跟着它 runs <id>。 。 。 .
candidates <run>列出视频家庭的拍摄候选人为JSON,包含状态,充电和预览. 免费.
uploads列出您上传的版本中, 修订版仍作为 JSON , 最新版本, 每个版本都有新的 URL 和 usable_until免费的.
workflows公共工作流程方法和作为JSON的可用性。 免费.
workflow-show <method>一种方法的规则,要求和限制作为JSON. 免费.
plan-create --file <path>存储 { document } 没有开始运行。 免费.
plan-show <plan>将当前拥有的计划和修订打印为JSON. 免费.
plan-save <plan> --file <path>保存 { base_version, document } 或本计划的全部计划显示产出。 免费.
plan-approve <plan> --file <path>明确核准 { revision, content_digest }。免费;开始不运行.
plan-quote <plan>将批准的计划引用为"JSON". 免费.
plan-run <plan> --file <path>启动一个明确按键的付费工作流程,并立即打印其收据和原地运行.

工作流程文件和明确采购

四种当地方法是: ugc-product-intro, (中文(简体) ), ugc-faq-answer, (中文(简体) ), faceless-explainer 财务报告和审定财务报表 product-image-story,服务器将其列为 可用. website-proof-demo 财务报告和审定财务报表 kinetic-launch 保留 execution_blocked 和原因有关.

工作流程命令打印出 JSON 为 stdout; API 拒绝信件, 包括全部 问题和警告,请到stderr。 文件必须是有效的 UTF-8 JSON 并且最多 1米B后再解析. 文件有单独的256 000个JSON字节限制. 拒绝未知的书写字段; 接受的原始描述被保存.

从一个方法的完整示例开始,然后编辑其摘要和证据到 跟你的意图一致 保存方法/能力指针并接受原始脚本:

clipwright workflow-show faceless-explainer > method.json
jq '{document: {v: 1, method: {method_id: .descriptor.id, version: .descriptor.version, content_digest: .descriptor.content_digest, capability_digest: .capabilities.content_digest}, brief: .descriptor.example.brief, beats: .descriptor.example.beats, claims: [], assets: []}}' method.json > create.json

在选择准确性之前,先检查计划的准备状态和警告 修订供核准:

clipwright plan-create --file create.json > plan.json
jq '{revision, content_digest}' plan.json > approval.json
clipwright plan-approve wfp_example --file approval.json
clipwright plan-quote wfp_example > quote.json

替换 wfp_example 与返回的计划编号。 在接受引用之后 价格,为这次购买选择一个稳定键,并精确提取发射 字段。 不要将整个引文作为发射文件发送:

jq '{revision, content_digest, semantic_input_digest, quote_id, idempotency_key: "workflow-example:1"}' quote.json > launch.json
clipwright plan-run wfp_example --file launch.json
clipwright runs run_example

使用返回的运行 ID runs. 发射不会等待视频. 如果答案不确定,则保留并明确重新发送原始文件 键以收回购买; 新键可以支付两次。 无工作流程命令 自动批准、引用、发射或选择新的尝试.

plan-show wfp_example > edited.json 生成您可以编辑和传递到的文件 plan-save wfp_example --file edited.json. CLI要求其最初的计划 id, 将其修订版作为基准版本, 并验证原始文档 严格地说。 未来文档字段在读取后幸存并导致不支持 保存在获取前失败。 返回失败的答案后, 重复明确保存 ; 不同的当前文档冲突.

runs 附带已购买的计划和可用的可选工作流程 JSON 文物/安置证据。 它保持本土状态和警告。 缺少证据 明确 null 涉及审定问题; [] 也就是说,没有核实位置. 历史证据不会更新下载 URL,以及 creative_acceptance: "not_reviewed" 与技术交付分开. 原始产品图像使用自有上传标识、文摘和不重叠 支持的 IMAGE shots 中的单词/引用锁定;生成的打开器是 说明。 所需的不支持的布局或未证实的保护位置 拒绝。 见 aPI合同。 。 。 .

原生视频命令

quote 财务报告和审定财务报表 make 把演员的照片当作 --image <url> 或者说 --image-file <path> (先装入后传入),加 --aspect-ratio 9:16|1:1|16:9 财务报告和审定财务报表 --resolution 720p|1080p。通过 --aspect-ratio 明确带有图片: 没有它,景观照片 使垂直,有一个警告.

选一个声音 --voice <name> 从目录,或 --voice-id <id> (单位:千美元) 外出的声音(例如克隆的声音). 既不设定,也不设定语音 遵循演员的性别: sarah 对于一个女人, george 为了男人 性别 从 --actor-id 目录条目,或来自 --actor-gender female|male 旁边 --image。默认演员说话 george。 。 。 . --image 无 --actor-gender 也会得到 george,并且反应会警告它. --actor-gender 与 --actor-id 被拒绝. voices 打印 a sample: 链接 每个声音:在支付一个渲染费之前播放,下次重复使用同一个名字. --language 用语音的母语过滤; 任何语音都说得到支持 语言.

语音决定语音模型: 每个预设,目录语音和 --voice-id 语音 说话 eleven_v4。 。 。 . --tts-model 覆盖选择 : eleven_flash_v2_5 财务报告和审定财务报表 eleven_turbo_v2_5 成本较低,但误读了俄罗斯的压力标记. --tts-model eleven_v3 实值 仍然接受,但跑步会说话 eleven_v4 并警告他们, 在俄语剧本中,马克 单词内有大写元音的压力: потОм。 。 。 . eleven_v4 财务报告和审定财务报表 gemini-3.8-flash-tts 读作压力. eleven_v4 财务报告和审定财务报表 gemini-3.8-flash-tts 不给一个暂停 <break time="…" /> 标签: 标签是从 文本, 和反应警告它.

gemini-3.8-flash-tts 只有三十个声音: voices --model gemini-3.8-flash-tts 列出他们。 命名一个( N)--voice kore)选择该模型时不使用 --tts-model· ; --tts-model gemini-3.8-flash-tts 无 --voice 说话 kore (单位:千美元) 妇女 charon 否则。 一个预设,一个目录的声音, --voice-id 财务报告和审定财务报表 --captions 在任何指控之前,都拒绝接受起诉。 它的声音有英语样本,和 voices --language ru 连接俄罗斯的.

quote-faceless 财务报告和审定财务报表 make-faceless 将描述取为 --script <text>, (中文(简体) ), --script-file <path> 或者说 --brief <text> (简短的描述: 页:1 --duration <seconds> 从30起至90起。 视频 以描述结尾,运行至少25秒(解释器,只要其 描述)并可能超过选择范围 最多四分之一,不超过90秒; 视频超过5秒 这么说的 warnings[]。如果估计长度为21,则接受脚本 秒到选择加5,最多90。 电荷跟随交货时间,且从未超过引文; 费率和最低金额 io/定价。 。 。 . 说明在; --no-captions 关掉它们. --style-reference <url> 财务报告和审定财务报表 --character-reference <url> 带 公共 https 图像. --voice <name> 选择叙事声音:取个名 从 voices --skill make_faceless,每行显示声音的语言 和性别。 没有它,叙述是读 narrator_en_wise_lady,则 英语解说者由最快的声音。 A 类 make 声音,如 george 并且拒绝在任何 收费。 引文首先:两个命令都取同一种旗帜,所以 引用确切价格的要求 make-faceless 将会发出.

shots <run> 打印文本:运行的行,是否可以编辑和 直到它的介质被存储,然后每发一行带有预览链接 硂 大源文件的链接点; 命令打印它和 没有下载。 API没有给出的描述或链接被打印为 withheld 或者说 none。无镜头的运行可以显示原因和出口 代码为0.

edit-show <run> 只写草稿的JSON来排队 这样你就可以保持它 文件, 更改 document 将文件传递到 edit-save; 版本和 草案的问题交给标准程序处理. edit-save <run> --file <path> 读取 version 财务报告和审定财务报表 document 从文件中忽略它的其他密钥并发送 作为基准版本和文档。 拒绝使用另一个形状的文件 任何请求。 如果因为草案有另一个版本而拒绝保存, 司令部看过草稿一次 如果草案已经保存您的文件 之后的版本中,一个更早的发送被通过,保存被如实报告. 否则它会报告与存储的版本的冲突: 运行 edit-show 将您的修改应用到草案中 将新草稿写入其它文件 而不是你通过的那个 --file。 。 。 .

revise-quote 财务报告和审定财务报表 revise 使用两个输入中的一个: --shot <id> 其中一个 --retake, (中文(简体) ), --new-picture <description> 或者说 --animate [motion],或 --document <path>,一个文件 edit-show 打印其编辑 document 这是 整个修订版。 交付的订正额按其引用总数计算 失败不收费。 同一请求再次返回它开始的运行; --retry 2 开始秒 修订。 在服务器上关闭付费编辑时, 两个命令都会回答 editing_disabled。 。 。 .

candidate-quote 财务报告和审定财务报表 candidate 带 --shot <id> 其中一个 --retake, (中文(简体) ), --new-picture <description> 或者说 --animate [motion],以及 --take <n>, 1 乘以 默认. candidate 先打印出价格,然后没有开始 --yes。 。 。 . (一) 交付的候选人应向其所在单位收取费用,无论该单位是否保留或废弃; 一个失败的,不收费。 同一请求,并再次发送返回他们开始的运行; --take 2 又成为另一个候选人,再次被起诉。 中枪的选手被关闭 服务器, 三个命令答案 editing_disabled。 。 。 .

make 复试是明确的: --retry 2 故意启动 新设 运行到 同样的剧本。 没有它,重复的呼叫 返回你已经支付运行, 因为每个请求都带有从输入和从输入中得出的一能键 这个装置的ID。 非数字 --retry 拒绝而不是强迫: 值最终会出现在那个键上,所以沉默 NaN {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}会给你买第二张图画.

设定 CLIPWRIGHT_CLIENT_ID 至稳定的入厂价值,或离开 ~/.clipwright/ 可写, 以便客户端在第一次使用时创建一个 。 它拒绝发明一个 丢弃 id, 因为每个进程 id 会禁用重复保护 沉默地——它未能捕到的复制品是第二次付费的渲染.

CLIPWRIGHT_API_URL 覆盖 API 基础 URL; 默认点 生产.

更改日志

每一版中的变化和被删除的 shitchwright.io/changelog (英语)。阅读其 断开 : 条目 升级前.

版本与发布记录

@clipwright/cli 共发布 53 个版本,首次发布于 2026/07/29;过去 12 个月发布了 53 个版本。

版本发布日期距今
0.47.0latest2026/11/09今天
0.46.02026/11/082 天前
0.45.02026/11/072 天前
0.44.02026/11/072 天前
0.43.12026/11/072 天前
0.43.02026/11/072 天前

关于 @clipwright/cli 的常见问题

@clipwright/cli 是什么?

Clipwright UGC 视频 API 的命令行客户端

如何安装 @clipwright/cli?

在项目目录运行 npm install @clipwright/cli,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 clipwright、clipwright-cli,可以用 npx clipwright 直接运行。

@clipwright/cli 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/clipwright__cli 是否存在。

@clipwright/cli 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@clipwright/cli 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=20。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@clipwright/cli 可以商用吗?

@clipwright/cli 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@clipwright/cli 的下载量有多少?

根据 npm 官方下载统计,@clipwright/cli 在 2026/10/10 – 2026/11/08 这 30 天内被下载 4,186 次,日均约 140 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@clipwright/cli 还在维护吗?

最新版本 0.47.0 发布于 2026/11/09(今天);至今共发布 53 个版本,其中过去 12 个月发布了 53 个;首次发布于 2026/07/29。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。