跳到主要内容

输出格式与错误码

面向 Agent / 脚本时,请以 --output json 的信封为准。

输出格式

格式适用场景
table人工查看(默认)
jsonAgent、脚本
csv导入 Excel
ndjson流式 / 大批量列表
kuaimai-cli auth status --output json
kuaimai-cli erp-item +list --body '{"pageNo":1,"pageSize":10}' --output ndjson

JSON 信封(当前契约)

成功示例:

{
"ok": true,
"data": { }
}

失败示例:

{
"ok": false,
"error": "错误说明",
"hint": "建议下一步"
}
字段说明
oktrue 成功 / false 失败
data成功时的业务数据;失败时通常省略
error字符串错误信息(非对象)
hint可选建议
_notice可选,升级等提示

兼容承诺:在未发重大版本说明前,保留 ok / data / error / hint 字段含义;error 保持为字符串。

列表分页字段随具体接口 data 结构返回(如 pageNo / pageSize / total),以 schema 与实际响应为准。

退出码

退出码含义
0执行成功
0执行失败(常见为 1
2可能为参数解析错误(依赖底层 flag 行为)

当前细分鉴权失败 / 网络错误等专用退出码。脚本请同时检查退出码与 JSON 的 ok

stdout / stderr

  • stdout:业务输出(--output json 时应为可解析 JSON)
  • stderr:日志、友好提示、升级通知等
  • --verbose 的调试信息走日志通道,解析 JSON 时请只读 stdout

分页相关全局参数

全局参数