Skip to main content

Spark Page CLI

Translation in progressThis guide is currently available in Simplified Chinese. A translated version will be added later.

spark-designer page 用于读取 Page Designer 的实际设计结果。它适合配置审计、发布前检查、问题定位和 AI 辅助分析，不要求用户直接理解或修改内部 Page JSON。

当前版本提供只读语义命令。新增控件、修改属性和配置交互仍在 Page Designer 中完成；后续 CLI 写操作会按组件业务语义逐项开放，不提供粗放的整页 JSON 覆盖入口。

1. 选择 App 和版本​

Page、Data、Task、SLA CLI 共用同一个 Spark Designer 上下文：

spark-designer page app list
spark-designer page app use spark-sample
spark-designer page current
spark-designer page version list
spark-designer page version entry

也可以在单条读取命令中指定目标：

spark-designer page summary --app spark-sample --version <version-id>

2. 查看页面配置摘要​

spark-designer page summary

摘要包括：

  • 页面模块数量。
  • 页面和菜单数量。
  • Page JSON 中可识别的组件数量。
  • 已启用页面和首页数量。
  • 当前版本中的页面名称、Route、类型和启用状态。

使用 JSON 交给脚本或 AI 继续分析：

spark-designer page summary --json

3. 模块、页面和菜单​

spark-designer page module list
spark-designer page list
spark-designer page menu list
spark-designer page menu list --module Components

页面引用支持 ID、Page Key、名称、标题和 Route。CLI 会优先精确匹配；存在多个候选时会拒绝猜测并返回候选列表。

4. 查看一个页面​

spark-designer page show DataList
spark-designer page show /data-list-sample
spark-designer page show e1842f50-fd00-44e2-aac2-8698a18edd93 --json

show 返回页面基础信息和组件清单，适合确认：

  • 页面名称、标题、Route、页面类型和首页状态。
  • 顶层 Screen、业务控件和子控件。
  • Component ID、父组件和隐藏状态。

5. 查看组件树​

spark-designer page tree DataList

CLI 从服务端返回的当前 Page JSON 中解析带 $class 和 elementId 的元素，并以层级结构输出。例如 DataList 页面会展示：

Page
  Screen
    DataList
      DataListColumn
      Field
      Button
      ProPagination

该命令只解析实际保存的结构，不根据控件名称臆测数据源或交互行为。需要查看完整属性时使用：

spark-designer page tree DataList --json

6. 常用审计流程​

spark auth status
spark-designer page app use spark-sample
spark-designer page summary
spark-designer page menu list
spark-designer page tree DataList
spark-designer page tree ProTable
spark-designer page tree TaskList

页面引用了 Business Object 或 DQL 时，继续使用 Spark Data CLI 检查对象、查询参数和物理映射。

7. 当前边界​

当前 Page CLI 不提供创建页面、删除页面、保存 Page JSON、修改组件属性或交互配置等写操作。页面写操作需要语义化命令、服务端元数据校验和显式确认，在这些约束完成前不开放原始 JSON 写入。

Last updated on