CLI 命令参考

SOURCE CLI 是系统接口,设计为 AI/脚本可调用。每个命令都有结构化的 JSON 输出。

安装与配置

配置 API Key

# 设置服务器地址
source config set-server https://source.ink

# 设置 API Key
source config set-key sk_xxx_your_api_key

# 验证连接
source config test

命令列表

color get

获取单个颜色的完整身份证数据。

source color get --id CN-Song-04 --json

参数:

  • --id: 颜色编号(必填)
  • --json: JSON 格式输出

color list

列出所有颜色。

source color list --limit 20 --json

参数:

  • --limit: 返回数量限制
  • --status: 筛选状态(VERIFIED/DRAFT)

color paper

获取颜色在指定纸张上的表现数据。

source color paper --id CN-Song-04 --paper PREMIUM_MATTE --json

参数:

  • --id: 颜色编号(必填)
  • --paper: 纸张类型(必填)

color recommend

获取颜色的纸张推荐。

source color recommend --id CN-Song-04 --goal fidelity --json

参数:

  • --id: 颜色编号(必填)
  • --goal: 优化目标(fidelity/cost/texture)

search

搜索颜色。

source search --q "烟雨" --json

config

管理 CLI 配置。

# 显示当前配置
source config show

# 设置 API Key
source config set-key sk_xxx

# 设置服务器地址
source config set-server https://source.ink

# 清除配置
source config clear

# 测试连接
source config test

# 查看可用工具
source config tools

全局选项

  • --json: 输出 JSON 格式(推荐 AI/脚本使用)
  • --no-color: 禁用彩色输出
  • --version: 显示版本号
  • --help: 显示帮助信息

错误码

代码说明
ERR_UNAUTHORIZEDAPI Key 无效或未配置
ERR_FORBIDDEN权限不足
ERR_NOT_FOUND资源不存在
ERR_RATE_LIMIT请求频率超限
ERR_VALIDATION参数验证失败

审计日志

每次 CLI 调用都会在服务端记录审计日志,包含:

  • 调用时间
  • API Key ID
  • 命令及参数(脱敏)
  • 执行结果
  • 引用的颜色/批次 ID