跳到主要内容

输出格式

Shoplazza CLI 支持多种输出格式和过滤选项。

--format 参数

格式说明适用场景
json结构化 JSON(默认)脚本、AI Agent、管道
pretty人类可读的键值对快速查看
table带表头的制表符分隔表格终端浏览

使用 --jq 过滤

shoplazza products list --jq '.data.products[].title'
shoplazza orders list --jq '.data.orders[] | {id, status, total_price}'
shoplazza products list --jq '.data.products | length'

-q--jq 的简写。

--fields 字段投影

快捷命令支持 --fields 选择输出列:

shoplazza products +search --keyword "shirt" --fields "id,title,price" --format table

--dry-run 预览请求

shoplazza products list --dry-run

显示将要发送的 HTTP 方法、URL、请求头和请求体,但不实际执行。

输出约定

  • stdout — 数据输出(JSON 信封),可安全管道传输
  • stderr — 进度指示器、警告和提示

成功信封

{"ok": true, "action": "products.list", "data": { ... }}

错误结构

{"error": {"type": "api", "message": "Product not found", "hint": "检查商品 ID 后重试"}, "request_id": "req_abc123"}

详见 错误格式