@shanjianai/open-cli
v0.1.0
Published
Official CLI for SJAI Open Platform
Downloads
24
Readme
sjai CLI
闪剪开放平台官方命令行工具。
安装
npm install -g @sjai/open-cli安装后:
sjai-open --helpAPI Key
使用此 CLI 工具需要 API Key。请访问:http://dev.shanjian.tv/ 获取您的 API Key。
认证
API Key 优先级顺序:
- CLI 参数
--api-key - 环境变量
SJAI_API_KEY - 本地配置(通过
sjai-open auth login保存)
命令:
sjai-open auth login --api-key <your-api-key>
sjai-open auth status
sjai-open auth logout全局选项
-i, --interactive缺少必需参数时提示输入--debug显示请求/响应调试信息--json机器可读的输出(默认)--output-format <format>输出格式:json, yaml, text, table--api-key <value>内联 API Key--base-url <url>覆盖 API 基础 URL--timeout <ms>请求超时覆盖-o, --output <path>下载输出文件路径--no-wait立即返回,不等待轮询
命令列表
task list|status|downloadvirtualman list|clone|deletevirtualman-fast clonevirtualman-image clonevideo digital-human|digital-human-mix|real-human-mix|material-mix|news|custom-digital|custom-material|custom-realvoice list|clone|deleteaudio tts|asrtemplate list|infocover list|createpublic-virtualman listpublic-voice listconfig list|set|getauth login|logout|status
使用示例
# 配置 API Key(只需一次)
sjai-open auth login --api-key sk-xxxx
# 查看任务列表
sjai-open task list
# 查询任务状态
sjai-open task status task_123
# 下载任务结果(需要指定输出路径)
sjai-open task download task_123 --output ./out/result.mp4
# 交互式视频创作
sjai-open video digital-human -i
# 非阻塞视频创作
sjai-open video news --title "每日简报" --content "..." --template-id tpl_1 --no-wait
# 不同格式输出
sjai-open public-voice list --output-format table
sjai-open template list --scene virtualman --output-format yaml输出和错误
- 人性化模式:简洁的文本,带有成功/错误/进度标记。
- JSON 模式:结构化数据,便于自动化处理。
- API/平台错误会包含
message和code。
开发
npm install
npm run typecheck
npm test
npm run build发布
- 更新
package.json中的version。 - 运行
npm run test。 - 运行
npm publish。
