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

Features ​

🔍

Service-level Semantic Verification

ServiceSpec contracts define preconditions and postconditions for each operation, enabling CEL-based semantic validation beyond simple schema checking.

⏱️

Orchestration-level Temporal Verification

FlowSpec contracts define step sequences and data flow, enabling temporal, causal, and DAG validation of service choreography.

📊

Real Trace-driven Validation

Validate contracts against actual execution traces (JSON/OTLP), bridging the gap between design and runtime behavior.

🚀

CI/CD Integration

Seamless integration with continuous integration pipelines for automated contract validation and governance.

🏗️

Atlas Component Family

Scout (discover), Proof (validate), and Pilot (lint) - complete toolchain for contract-driven development.

📋

Open Source Community Edition

Use the published CE beta to discover, lint, and validate contracts locally.

Beta Version

ChoreoAtlas CLI is currently in Beta status. Features and APIs may change as we continue to improve the product. We welcome your feedback and contributions!

Quickstart (5 minutes) ​

bash
# 1) One-line alias (no local install)
alias choreoatlas='docker run --rm --user $(id -u):$(id -g) -v $(pwd):/workspace -w /workspace choreoatlas/cli:0.2.0-ce.beta.1'

# 2) Validate a sample flow and emit an HTML report
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

Expected output

  • PASS/FAIL lines for each orchestration step (e.g. [PASS] Create Order)
  • reports/validation-report.html rendered with timeline, coverage, and gate status

Tips

  • Use the quickstart demo for a ready-to-run workspace (git clone … && make demo).
  • Continue with Getting Started to generate and inspect both real sample reports.

Available Release ​

The published CLI release is Community Edition 0.2.0-ce.beta.1. Its binaries and Docker image support local contract discovery, linting, validation, and reports. Pro and Cloud offerings are not presented as available releases here.


Released under the MIT License.