Shoplazza CLI 概述
Shoplazza CLI 是一个命令行工具，用于构建 Shoplazza 应用、主题和扩展。它覆盖完整的开发生命周期——从项目脚手架、本地开发到部署和版本管理。
v2 新特性
Shoplazza CLI v2 是一次全面重写，引入了三层命令体系、OAuth 2.0 认证和面向人类开发者与 AI Agent 的结构化输出。
三层命令体系
| 层级 | 前缀 | 用途 | 示例 |
|---|---|---|---|
| 快捷命令 | + | 高频操作，智能默认值 | shoplazza products +search --keyword "shirt" |
| API 命令 | — | 与平台 API 1:1 映射 | shoplazza products list --format table |
| 原始 API | api rest | 任意端点的逃生舱 | shoplazza api rest GET /openapi/2026-01/products |
详见 三层命令体系。
核心能力
- 应用生命周期 — 使用
app init、app dev、app deploy初始化、开发和部署应用 - 主题开发 — 脚手架、预览、推送和发布主题（
themes init、serve、pull、push、package、share），并可在themes env中配置命名环境 - 扩展开发 — 使用内置工具链构建 Checkout 扩展和 Theme 扩展
- 店铺数据 — 通过快捷命令和 API 命令管理商品、订单、客户、折扣等
- 计费与 Webhook — 创建订阅和注册事件钩子
- Schema 自省 — 使用
shoplazza schema探索所有可用 API - 店铺 Profile — 通过
profile和--profile，一次登录即可操作多个店铺 - Agent Skills — 使用
shoplazza skills阅读 CLI 内置的 AI 智能体指引
业务域覆盖
| 业务域 | 快捷命令 | API 命令数 |
|---|---|---|
| 商品 | +search, +create, +set-price, +stock, +publish, +unpublish, +count, +set-variants, +tag | 79 |
| 订单 | +search, +count, +ship, +refund, +update-tracking | 38 |
| 折扣 | +search, +rebate, +flashsale, +mn-discount, +percent-code, +amount-code, +bxgy-code, +free-shipping-code | 15 |
| 客户 | +search, +create, +count | 11 |
| 店铺 | +upload-file | 95 |
| 主题 | +page, +edit, +card-schema, +preview, block +edit, block +get | 56 |
| 计费 | — | 14 |
| Webhook | — | 6 |
安装
参见 安装 Shoplazza CLI。
快速开始
命令参考
查看 命令参考 了解所有可用命令。
认证
Shoplazza CLI v2 使用 OAuth 2.0 + PKCE 进行安全认证。支持浏览器交互式登录和 CI/CD 环境下使用 UAT 令牌的非交互式认证。
详见 认证。
输出格式
所有命令通过全局 --format 参数支持结构化输出：
| 格式 | 说明 |
|---|---|
json | 结构化 JSON（管道、CI 或带 --no-input 时的默认格式）— 适合脚本和 AI Agent |
pretty | 人类可读的键值对显示（交互式终端下的默认格式） |
table | 带表头的对齐表格 |
ndjson | 每行一个 JSON 对象；列表结果每行输出一条记录 |
csv | 带表头行的 CSV，便于导出到电子表格 |
还可以使用 --jq 表达式过滤 JSON 输出，使用 --dry-run 预览请求。
详见 输出格式。
升级
通过 npm 安装时运行以下命令升级（同时会刷新 API 元数据）：
shell
shoplazza update
其他安装方式参见 升级。
查看当前版本：
shell
shoplazza --version
主题开发
主题相关的 CLI 使用说明，请参见 主题 CLI 指南。