CLI
CLI 概览
tufty 的命令一览与通用约定。
命令
| 命令 | 作用 |
|---|---|
tufty <tool> | 运行一个工作室工具,例如 tufty pet-dressup。见 工具 |
tufty tools list | 列出所有工具 |
tufty tools describe <id> | 输出单个工具的完整信息:输入、选项、价格与限制 |
tufty status <runId> | 查询任务;加 --wait 等到完成 |
tufty upload <file> | 把文件上传到 tufty 存储,输出公开地址 |
tufty login | 浏览器设备码登录 |
tufty auth set <apiKey> | 保存 API 密钥 |
tufty auth get | 查看当前生效的密钥(默认遮蔽) |
tufty logout | 从配置文件中删除密钥 |
工具命令从哪来
工具命令和它们的参数不是写死在 CLI 里的。CLI 运行时读取服务端的工具清单(本地缓存 10 分钟),按清单注册命令、生成选项并校验取值。网站上新增工具、调整价格或选项后,CLI 不用升级就能跟上 —— 所以任何时候都以 tufty <tool> -h 的输出为准。
auth、login、logout、upload、status 不依赖工具清单,运行时不会去拉取它。
通用约定
- 标准输出只有一个 JSON 信封,进度写入标准错误。见 输出模式。
- 退出码:
0成功,1运行或接口错误,2用法错误。见 退出码。 - 数量、文件是否存在、选项取值都在上传之前校验,参数写错不会白花积分。
- 命令名拼错时返回
unknown_command,details.suggestions里是最接近的命令。
常用组合
# 有哪些工具
tufty tools list
# 一个工具当前的参数与价格
tufty pet-dressup -h
tufty tools describe pet-dressup
# 先预估,再运行
tufty pet-dressup --product ./sweater.jpg --model ./corgi.jpg --quality medium --dry-run
tufty pet-dressup --product ./sweater.jpg --model ./corgi.jpg --quality medium --save ./out