@yikeai/cli

Yike CLI

Yike CLI 是 Yike 提供的命令行工具，可在终端或 AI Agent 中完成本地图片/视频上传、图片生成、视频生成、媒资检查以及异步任务管理。

功能

• 文生图、图生图
• 文生视频、图生视频、参考视频生成
• 上传本地图片和视频，并在失败后继续上传或等待
• 查询生成任务状态并恢复本地记录的异步任务
• 检查媒资地址、时长和分辨率
• 提供适合脚本和 AI Agent 消费的 JSON 输出
• 内置并自动尝试安装配套的 using-yike-cli Agent skill

环境要求

• Node.js 18 或更高版本
• npm
• 可用的 Yike 账号

安装

使用 npm 全局安装：

npm install -g @yikeai/cli

确认安装成功：

yike --version
yike --help

如果当前 npm registry 无法找到该包，请显式使用 npm 官方源：

npm install -g @yikeai/cli --registry=https://registry.npmjs.org

登录

在终端中完成浏览器授权：

yike auth login

无法自动打开浏览器时，可以只输出登录地址：

yike auth login --no-open

检查登录状态和当前账号：

yike auth status
yike whoami

在无法完成浏览器回调的自动化环境中，也可以通过环境变量提供访问令牌：

export YIKE_API_TOKEN="<your-token>"

请勿把访问令牌写入脚本、日志或版本库。

配置工作区和项目

查看当前配置：

yike config get

设置默认工作区：

yike config set workspaceId <workspaceId>

交互式选择该工作区中的项目：

yike config set projectId

脚本或 AI Agent 应先获取项目列表，再显式设置项目 ID：

yike config list projectId --format json
yike config set projectId <projectId> --format json

也可以通过 --workspace-id 和 --project-id 为单次生成覆盖默认配置。

生成图片

yike generate image "一张未来感咖啡品牌海报" \
  --aspect-ratio 16:9 \
  --resolution 1K \
  --wait

生成多张图片并输出 JSON：

yike generate image "暖色水彩风格的海边小镇" \
  --n 2 \
  --wait \
  --format json

查看当前支持的模型和完整参数：

yike generate image --help
# Agent / 脚本读取当前可见模型、默认值和能力
yike generate image --help --format json

生成视频

yike generate video "5 秒咖啡广告短片，镜头缓慢推进" \
  --duration 5 \
  --resolution 720P \
  --wait

查看当前支持的模型和完整参数：

yike generate video --help
# Agent / 脚本读取参考输入、时长、分辨率、比例和音频能力
yike generate video --help --format json

结构化 help 只读取内置模型目录与本地白名单缓存，不发起网络请求；模型条目按 model + taskType + mode 扁平导出 capability manifest，通过输入/输出模态、typed parameters、参考素材和条件约束描述能力。字段缺失表示当前上游能力未声明，目录之外的显式 --model 仍会透传给服务端。完整字段与兼容规则见 docs/model-help-json.md。

提交生成任务前，CLI 会展示预计积分消耗并请求确认。自动化流程可以先使用 --dry-run 检查计费估算和请求参数；JSON 中只有 estimation.matched: true 才表示预估有效，matched: false 是价格未知而不是免费，此时 insufficient 为 null。仅在预估有效且已经获得用户授权时使用 --yes 跳过确认。

使用本地参考素材

本地图片或视频必须先上传为 Yike 媒资：

yike media upload "/absolute/path/to/reference.png" --format json

上传完成后，从 JSON 结果中取得非空的 mediaId，再传给生成命令：

yike generate video "让画面中的人物自然转身" \
  --reference-image <mediaId> \
  --wait \
  --format json

支持的本地格式：

• 图片：png、jpg、jpeg、bmp、webp
• 视频：mp4、mov

上传超时时，执行返回结果中的 resumeCommand 继续等待。上传或注册失败时，可以重新执行相同的 media upload 命令，CLI 会使用本地检查点继续处理。

HTTP(S) 素材地址和已有的 mediaId 可以直接传给相应的 --reference-image 或 --reference-video 参数，不需要重复上传。

异步任务

不使用 --wait 时，生成命令会返回异步任务信息。可以使用任务 ID 继续查询：

yike job watch <jobId> --wait --format json

恢复本机记录的任务：

yike job recover <jobId> --format json

如果命令返回 resumeCommand 或 nextAction.command，建议直接执行该命令，以保留原任务的工作区、项目、轮询和输出格式参数。

检查生成结果

查询一个或多个媒资：

yike media info <mediaId> --format json

检查视频时长和最低分辨率：

yike media doctor <mediaId> \
  --expect-duration 5 \
  --min-width 1280 \
  --min-height 720 \
  --format json

AI Agent 集成

全局安装或升级 CLI 时，会自动尝试将内置的 using-yike-cli skill 同步到常见 Agent skill 目录。需要手动安装或修复时执行：

yike self skill install --format json

安装到指定的 skill 根目录：

yike self skill install --target <skill-root> --format json

Agent 调用 CLI 时建议统一使用 --format json，并根据返回的 jobId、mediaId、resumeCommand 或 nextAction.command 继续后续操作。

环境变量

环境变量会覆盖本地保存的默认配置：

变量	用途
YIKE_API_TOKEN	Yike API 访问令牌
YIKE_WORKSPACE_ID	默认工作区 ID
YIKE_PROJECT_ID	默认项目 ID
YIKE_PRODUCTION_ID	项目 ID 的兼容变量
YIKE_MODEL	默认生成模型

更新与卸载

检查是否有新版本：

yike update --check

升级到最新版本：

yike update

使用 npm 卸载：

npm uninstall -g @yikeai/cli

常见问题

yike: command not found

检查 npm 全局可执行目录是否位于 PATH：

npm prefix -g

安装时报 Node.js 版本不兼容

升级到 Node.js 18 或更高版本后重新安装。

npm 返回 404

确认使用的是 npm 官方 registry：

npm install -g @yikeai/cli --registry=https://registry.npmjs.org

登录或鉴权失败

重新执行：

yike auth login

项目无权限或项目配置错误

重新获取当前账号可用的项目并设置正确的 projectId：

yike config list projectId --format json
yike config set projectId <projectId> --format json

许可证

本项目采用 MIT 许可证。