Aller au contenu principal

Spark CLI 总体介绍

Traduction en coursCe guide est actuellement disponible en chinois simplifié. Une version traduite sera ajoutée ultérieurement.

Spark CLI 是 Spark 面向开发人员、FDE、测试人员和 AI 助手提供的统一命令行入口。它通过 Spark Access Key 调用与 Spark Console 相同的后端能力，把需要重复执行、批量检查或由 AI 协助完成的工作变成可读、可确认、可追踪的命令。

spark auth status
spark guide --format markdown
spark-designer guide --format markdown
spark-designer task current
spark worklist my-pending --app spark-sample --env dev

1. 为什么需要 Spark CLI​

Spark Console 适合可视化设计、浏览和人工评审；Spark CLI 解决的是另一类问题：

  • 稳定自动化：同一条命令可在本地、脚本、CI 或 AI 会话中重复执行。
  • 业务语义：命令表达“选择工作流”“增加节点”“从 A 连到 B”“给连线增加校验”，而不是要求用户拼装内部 JSON。
  • 上下文保持：可以先选择 App、设计版本、工作流或 Blueprint，后续命令复用当前上下文。
  • 安全写入：删除、导入、应用包和工作流修改等高影响操作要求明确的 --yes 确认。
  • AI 工具桥梁：同一套 CLI 还可以生成 Codex skills、Codex MCP 配置和 Claude Code slash commands。
  • 便于验收：设计资产、Worklist、任务详情、SLA 和系统日历都可以输出为 Markdown、表格或 JSON。

:::info CLI 与页面不是替代关系 页面负责可视化设计和人工治理，CLI 负责自动化、批处理、验收和 AI 调用。对于复杂工作流，日常编辑应使用节点、连线和规则命令；整份 JSON 只保留给迁移、恢复和精确 round trip。 :::

2. 当前模块​

命令族主要用途读写性质
spark auth管理本地连接 profile 和 Access Key本地配置
spark-designer taskSpark Task CLI：管理任务类型、字段、表单、步骤、工作流、权限和翻译读写
spark-designer pageSpark Page CLI：检查模块、页面、菜单和语义组件树只读
spark-designer dataSpark Data CLI：检查 Business Object、字段、DQL、Source Profile 和 Mapping只读
spark-designer slaSpark SLA CLI 设计态：检查策略、指标、日历、目标和动作只读
spark worklist查询我的待办、我创建的、我处理的、Filter 和 TQL只读
spark task查看任务详情、预检查并创建任务读写
spark calendar查看系统日历、工作日和例外日期只读
spark sla查看 SLA 运行实例、风险、违约和诊断；执行受保护的维护命令读写
spark blueprint管理业务蓝图、Discovery、AI 候选和报告读写
spark integrations安装 Codex 和 Claude Code 集成本地配置
spark mcp检查或启动 Spark MCP server本地服务

3. CLI 的工作方式​

一次典型操作包含四层上下文：

  1. 认证 profile：决定连接哪个 Spark 服务以及使用哪组 Access Key。
  2. App 与版本：任务设计器选择当前 App 和可编辑版本。
  3. 业务对象：例如选择当前工作流，再用名称、编号或 ID 操作节点和连线。
  4. 环境：任务运行期明确选择 DEV、TEST 或 PROD。
spark auth use spark-dev
spark-designer task app use spark-sample
spark-designer task workflow use "Purchase Approval"
spark-designer task workflow describe --lang zh-CN

spark worklist my-pending --app spark-sample --env dev

CLI 的本地上下文不会改变 Spark Console 中其他用户的页面选择；真正的写操作仍会修改目标 App 或环境中的 Spark 数据。

设计器命令采用稳定的两级命名空间：

spark-designer <task|page|data|sla> <resource> <action>

例如，field 明确属于 Task Designer，因此使用 spark-designer task field list；业务对象字段未来会使用 spark-designer data ...，不会与任务字段混在同一个不明确的 designer field 入口中。

:::info 旧命令兼容 Spark CLI 0.1.x 的 spark designer field list 等任务设计器命令仍然可用。新脚本和文档应使用 spark-designer task ...。 :::

4. 帮助与输出格式​

不确定命令时，先读取 CLI 自己生成的帮助：

spark guide --format markdown
spark guide auth --format markdown
spark-designer guide --format markdown
spark-designer task guide --format markdown
spark-designer page guide --format markdown
spark-designer data guide --format markdown
spark-designer sla guide --format markdown
spark guide worklist --format markdown
spark guide task --format markdown
spark integrations doctor

常用输出参数：

参数用途
--format markdown适合终端、文档和 AI 会话阅读
--format table 或 --table输出传统终端表格
--json 或 --format json供脚本和 AI 结构化处理
--csv导出列表数据
--output <file>将结果写入文件
--lang zh-CN指定后端返回文案的语言
--yes明确确认受保护的写操作

5. 推荐阅读顺序​

  1. 安装与认证
  2. 集成 Codex
  3. 集成 Claude Code
  4. Spark Task CLI
  5. Spark Page CLI
  6. Spark Data CLI
  7. Spark SLA CLI
  8. 工作流语义化编辑
  9. 任务运行期与 Worklist
  10. Spark Blueprint AI CLI
Dernière mise à jour le