跳到主要内容

输出格式

cosh-cli 的所有命令输出统一的 JSON 信封 CoshResponse<T>,方便 AI Agent 解析。

成功响应

{
"ok": true,
"data": { ... },
"meta": {
"subsystem": "pkg",
"duration_ms": 342,
"distro": "alinux",
"dry_run": false
}
}

错误响应

{
"ok": false,
"error": {
"code": "PkgNotFound",
"message": "package 'nginx-extra' not found",
"recoverable": true,
"hint": "try 'cosh-cli pkg search nginx'",
"subsystem": "pkg"
},
"meta": {
"subsystem": "pkg",
"duration_ms": 120,
"distro": "ubuntu",
"dry_run": false
}
}

关键字段

字段类型说明
okbool操作是否成功
dataobject成功时携带的业务数据
error.codestring错误码枚举(详见下方)
error.recoverableboolAgent 是否值得重试
error.hintstring建议的下一步操作
meta.subsystemstring来源子系统(pkg/svc/checkpoint/audit)
meta.duration_msu64操作耗时(毫秒)
meta.distrostring当前检测到的发行版
meta.dry_runbool是否为预览模式

错误码

错误码子系统含义
PkgNotFoundpkg包不存在
PkgBackendErrorpkg包管理器执行失败
UnsupportedDistropkg/svc不支持的发行版
SvcNotFoundsvc服务不存在
SvcStartFailedsvc服务启动失败
SvcStopFailedsvc服务停止失败
CheckpointDaemonUnavailablecheckpointws-ckpt 守护进程未运行
CheckpointNotFoundcheckpoint快照不存在
AuditDeniedaudit策略拒绝
Timeout*命令执行超时
PermissionDenied*权限不足

退出码

  • 0 — 操作成功(ok: true
  • 1 — 操作失败(ok: false

Agent 对接模式

对于 AI Agent 消费 cosh-cli 输出,推荐以下模式:

  1. 解析 JSON,检查 ok 字段
  2. ok: false,读取 error.recoverable 决定是否重试
  3. 若不可恢复,展示 error.hint 给用户或执行 hint 中的建议命令
  4. meta.dry_runtrue 时,表示这是预览结果,实际操作尚未执行