Skip to content

ChoreoAtlas CLI

Contract-as-Code Orchestration

Map, Verify, Steer your choreography

✓Service-level Semantic Verification
✓Orchestration-level Temporal Verification
✓Trace-driven Validation
GatewayCreate OrderPaymentShipPASSPASSPASSPASSTrace Timeline100msReport Generatedvalidation-report.htmlContract-as-Code VerificationService → Orchestration → Temporal

功能亮点 ​

🔍

服务级语义验证

ServiceSpec 契约定义操作的前置/后置条件,提供超越模式校验的基于 CEL 的语义验证。

⏱️

编排级时序验证

FlowSpec 定义步骤与数据流,实现时序、因果与 DAG 校验。

📊

真实追踪驱动

基于实际执行追踪(JSON/OTLP)进行验证,连接设计与运行时行为。

🚀

CI/CD 集成

与持续集成管道无缝结合,实现自动化契约验证与治理。

🏗️

Atlas 组件家族

Scout(探索)、Proof(校验)、Pilot(规范)组成完整工具链。

📋

开源社区版

使用已发布的 CE 测试版,在本地探索、检查和校验契约。

Beta 版本

ChoreoAtlas CLI 目前处于 Beta 状态。我们持续改进产品,功能和 API 可能会发生变化。欢迎您的反馈和贡献!

5 分钟极速上手 ​

bash
# 1)一行别名(无需本地安装)
alias choreoatlas='docker run --rm --user $(id -u):$(id -g) -v $(pwd):/workspace -w /workspace choreoatlas/cli:0.2.0-ce.beta.1'

# 2)执行校验并生成 HTML 报告
choreoatlas validate \
  --flow contracts/flows/order-flow.graph.flowspec.yaml \
  --trace traces/successful-order.trace.json \
  --report-format html --report-out reports/validation-report.html

预期输出

  • 每个编排步骤的 PASS/FAIL 行(例如 [PASS] 创建订单)
  • reports/validation-report.html,包含时间线、覆盖率和 Gate 状态

提示

  • 使用 quickstart-demo 获得开箱即用的环境(git clone … && make demo)。
  • 继续阅读 快速开始,生成并检查两份真实示例报告。

当前可用版本 ​

已发布的 CLI 版本是社区版 0.2.0-ce.beta.1,提供二进制文件与 Docker 镜像,可在本地探索、检查和校验契约并生成报告。Pro 与 Cloud 暂无可核实的公开发行版。


Released under the MIT License.