基础用法
Beta 版本
ChoreoAtlas CLI 仍在 Beta 阶段,命令与参数可能调整。
本页汇总快速上手后的常用命令,便于日常开发与运维。
别名回顾
bash
alias choreoatlas='docker run --rm --user $(id -u):$(id -g) -v $(pwd):/workspace -w /workspace choreoatlas/cli:0.2.0-ce.beta.1'该别名固定使用 CE Beta 镜像,无需本地安装。
Lint FlowSpec
bash
choreoatlas lint --flow contracts/flows/order-flow.graph.flowspec.yaml --schema=false该命令跳过 JSON Schema,仅检查图结构。当前 Beta 随附的 schema 不接受 quickstart 图示例的全部字段,不能把上述命令当作完整的 schema 校验。已验证的两份报告请运行 快速开始 中的 make demo。
根据追踪执行校验
bash
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常见参数:
--threshold-steps、--threshold-conds:覆盖率 / 条件通过率阈值--skip-as-fail:将 SKIP 条件视为失败--baseline、--baseline-missing:基线对比策略--report-format、--report-out:生成 HTML / JSON / JUnit 报告
从追踪生成契约
bash
choreoatlas discover --trace traces/successful-order.trace.json --out contracts/flows/order-flow.discovered.flowspec.yaml --out-services contracts/services.discovered生成后可人工审阅、保留或与已有契约对比。
重现两份示例报告
bash
make demo退出码(速查)
| 退出码 | 含义 |
|---|---|
0 | 成功 |
1 | CLI 错误(参数无效等) |
2 | 输入或解析错误 |
3 | 校验失败 |
4 | Gate 失败(阈值或基线不满足) |