API 参考

Beta 版本

ChoreoAtlas CLI 目前处于 Beta 状态，API 和命令接口后续可能调整。

欢迎使用 ChoreoAtlas CLI API 参考。本节为 CLI 命令、配置选项和集成模式提供完整文档。

📚 文档章节

CLI 命令

• 核心命令：discover、validate、lint、ci-gate
• 参数与退出码说明
• 示例与工作流程

🚀 快速命令参考

# 可选：一行别名（免安装）
alias choreoatlas='docker run --rm --user $(id -u):$(id -g) -v $(pwd):/workspace -w /workspace choreoatlas/cli:0.2.0-ce.beta.1'

# 从追踪生成契约（FlowSpec + ServiceSpec）
choreoatlas discover --trace <trace.json>   --out <flowspec.yaml>   --out-services <dir>

# 根据追踪校验编排
choreoatlas validate --flow <flowspec.yaml> --trace <trace.json>

# 结构与 Schema 校验
choreoatlas lint --flow <flowspec.yaml>

# CI/CD 门禁
choreoatlas ci-gate --flow <flowspec.yaml> --trace <trace.json>

获取帮助

choreoatlas --help
choreoatlas validate --help
choreoatlas discover --help
choreoatlas lint --help

📖 推荐阅读

• 快速开始 — 完整的探索 → 校验闭环
• 基础用法 — 日常常用命令速查
• 安装指南 — Docker / 二进制 / 源码

🔗 外部资源

• GitHub 仓库 — 源码与 Issues
• Docker Hub — 官方镜像
• 快速演示 — 可运行示例