命令参考
本参考文档列出所有 Shoplazza CLI 命令，按主题分组。
命令语法
shoplazza [主题] [命令] [参数]
三层命令体系
| 层级 | 语法 | 适用场景 |
|---|---|---|
| 快捷命令 | shoplazza <主题> +<操作> | 日常操作，智能默认值 |
| API 命令 | shoplazza <主题> <操作> | 完整控制 API 参数 |
| 原始 API | shoplazza api rest <方法> <路径> | 上述未覆盖的任意端点 |
详见 三层命令体系。
命令分组
分组与 shoplazza --help 一致：店铺与业务、开发、设置与工具。
店铺与业务
店铺数据（快捷命令 + API 命令）
| 主题 | 快捷命令 | API 命令数 | 参考 |
|---|---|---|---|
| 商品 | +search, +create, +set-price, +stock, +publish, +unpublish, +count, +set-variants, +tag | 79 | products |
| 订单 | +search, +count, +ship, +refund, +update-tracking | 38 | orders |
| 折扣 | +search, +rebate, +flashsale, +mn-discount, +percent-code, +amount-code, +bxgy-code, +free-shipping-code | 15 | discounts |
| 客户 | +search, +create, +count | 11 | customers |
| 店铺 | +upload-file | 95 | shop |
| 主题 (API) | +page, +edit, +card-schema, +preview, block +edit, block +get | 56 | themes-api |
| 计费 | — | 14 | billing |
| Webhook | — | 6 | webhook |
shoplazza schema <主题> 可列出该主题的 API 命令。
平台功能
| 命令 | 说明 |
|---|---|
| billing one-time | 一次性收费管理 |
| billing recurring | 周期性订阅管理 |
| billing usage | 用量计费 |
| billing transactions | 交易查询 |
| webhook create | 注册事件 Webhook |
| webhook list | 列出已注册的 Webhook |
| webhook get | 查看 Webhook |
| webhook update | 更新 Webhook |
| webhook delete | 删除 Webhook |
| webhook count | 统计 Webhook 数量 |
原始 API
| 命令 | 说明 |
|---|---|
| api rest | 发送原始 HTTP 请求到任意端点 |
开发
应用开发
| 命令 | 说明 |
|---|---|
| app init | 初始化或链接应用项目 |
| app list | 列出账户下的应用 |
| app info | 显示应用元数据 |
| app dev | 启动本地开发服务器 |
| app deploy | 部署应用到生产环境 |
| app config link | 链接应用配置 |
| app config use | 切换应用配置 |
| app config push | 将 [dashboard] 配置推送到 Partner 后台 |
| app extension create | 创建扩展脚手架 |
| app versions | 列出已部署版本 |
| app function compile | 编译 Function 扩展为 WASM |
| app function release | 编译并发布 Function 扩展 |
| app function list | 列出 Function 扩展 |
主题开发
| 命令 | 说明 |
|---|---|
| themes init | 创建新主题脚手架 |
| themes serve | 实时预览主题 |
| themes pull | 从店铺下载主题 |
| themes push | 上传主题到店铺 |
| themes package | 打包主题为 ZIP |
| themes share | 分享主题预览链接 |
| themes env list | 列出 shoplazza.theme.toml 中的环境 |
| themes env show | 显示某个环境的配置 |
| themes env check | 离线校验环境 |
| themes env add | 添加环境 |
| themes env set | 修改环境的字段 |
| themes env remove | 删除环境 |
店铺主题操作（themes list、themes +page、themes +edit 等）见上方店铺数据表格中的“主题 (API)”一行。
扩展开发
checkout 是 checkout-extension 的别名，te 是 theme-extension 的别名。
| 命令 | 说明 |
|---|---|
| checkout-extension init | 创建 Checkout 扩展项目脚手架 |
| checkout-extension create | 在已有项目中添加扩展 |
| checkout-extension dev | 本地开发服务器 :8888 |
| checkout-extension build | 使用 Vite 构建扩展 |
| checkout-extension push | 上传新版本 |
| checkout-extension preview | 生成某个版本的预览 URL |
| checkout-extension deploy | 激活版本 |
| checkout-extension undeploy | 取消部署扩展 |
| checkout-extension list | 列出 Checkout 扩展 |
| checkout-extension versions | 列出扩展的版本 |
| theme-extension create | 创建 Theme 扩展脚手架 |
| theme-extension serve | 增量同步开发服务器 |
| theme-extension build | 构建新版本 |
| theme-extension deploy | 在店铺启用版本 |
| theme-extension connect | 将扩展链接到应用 |
| theme-extension release | 在绑定应用中发布版本 |
| theme-extension list | 列出店铺的 Theme 扩展 |
| theme-extension versions | 列出扩展的版本 |
设置与工具
认证与配置
| 命令 | 说明 |
|---|---|
| auth login | 通过 OAuth 2.0 登录 |
| auth logout | 移除所有 Profile 和存储的凭证 |
| auth status | 显示当前认证状态 |
| auth scopes | 显示支持的和已授权的 OAuth 作用域 |
| auth store use | 切换到其他店铺 |
| profile add | 为店铺添加 Profile |
| profile list | 列出已配置的 Profile |
| profile info | 显示 Profile 详情 |
| profile use | 切换当前 Profile |
| profile update | 修改 Profile 的作用域 |
| profile rename | 重命名 Profile |
| profile remove | 删除 Profile |
工具命令
| 命令 | 说明 |
|---|---|
| schema | 查看可用的 API 及参数 |
| skills list | 列出 CLI 内置的 Agent Skills |
| skills read | 打印某个技能或其参考文件 |
| update | 更新 CLI 到最新版本并刷新 API 元数据 |
| completion | 生成 Shell 自动补全脚本 |
| doctor check | 运行诊断检查 |
--version / -v | 显示 CLI 版本 |
--help / -h | 显示命令帮助 |
全局参数
| 参数 | 说明 |
|---|---|
--format <json|pretty|table|ndjson|csv> | 输出格式（默认：交互式终端下为 pretty，管道、CI 或带 --no-input 时为 json；SHOPLAZZA_CLI_FORMAT 可覆盖默认值） |
--no-input | 从不提示，缺少输入时立即失败（适用于脚本和智能体） |
--profile <名称> | 本次调用使用的 Profile |
--help / -h | 显示命令帮助 |
--version / -v 只用于根命令（shoplazza --version）。API 命令、快捷命令和 api rest 还支持 --jq <表达式> / -q（过滤 JSON 输出；在交互式终端中需加 --format json）和 --dry-run（预览请求，不实际执行）。
详见 全局参数。