项目简介

OpenCLI 是由 Spectre Console 社区推动的 CLI 规范草案,目标是用机器可读方式描述命令、参数、选项、退出码与示例,可理解为“CLI 版 OpenAPI”。它特别适合把内部 CLI 工具产品化:一份描述同时服务文档生成、自动补全、变更检测,以及 OpenCLI → MCP 的桥接自动化。我们提供从现有 CLI 盘点、规范建模到 CI 治理的完整落地服务。

CLI 契约化

把 help 文本升级为机器可读规范,形成稳定的命令接口契约

MCP 桥接

用 OpenCLI 做上游描述层,向下游文档站、MCP 工具和自动化流程分发

文档自动化

基于同一份 schema 生成文档、示例、补全和消费端适配层

变更治理

在 CI 中检测命令面破坏性变更,减少 CLI 漂移带来的集成事故

我们提供的服务

部署服务

CLI 存量盘点梳理现有命令树、参数命名、退出码和示例,识别高风险不一致点
规范建模导出为 Spectre.Console.Cli 或既有 CLI 增加 OpenCLI 导出能力,生成统一描述文件
文档与门户接入将 OpenCLI 产物接入官网、开发者门户或内部文档站,形成可检索资料
OpenCLI → MCP 桥接把高价值命令映射成 MCP tool schema,供 Agent 与自动化系统消费
CI 版本治理增加 schema diff、breaking change 检测与版本发布流程

运维服务

规范漂移跟踪跟踪 upstream 规范变更,定期检查 discovery、类型边界等设计更新
兼容性回归验证导出器、消费端和生成链路在升级后是否保持一致行为
生成链路维护按需重建文档、补全和 MCP 适配产物,避免多份描述分叉
团队培训输出 CLI 契约设计规范、命名约束和 PR 审核清单,降低后续维护成本

GitHub 实战调研(2026-03-26)

截至 2026-03-26:OpenCLI 仍以 draft/proposal 形态推进,方向很对,但发现机制、根命令建模、类型系统边界仍在讨论中。2025-07-07 发布介绍文章,2025-10-10 Spectre.Console.Cli 0.52.0 加入原生导出能力。当前更适合作为团队内部 CLI 的机器可读契约层,而非立即对外承诺的稳定跨生态标准。

相关调研资料

主流部署方案

Spectre.Console.Cli 原生导出版

Spectre.Console.Cli 0.52+ + --help-dump-opencli / cli opencli 导出。

适合已经使用 Spectre.Console.Cli 的 .NET 团队,以最低改造成本生成 OpenCLI 规范。

  • 依托官方集成能力,升级路径最清晰
  • 输出格式与上游规范贴近,后续维护成本较低
  • 适合作为首个试点项目快速验证价值

存量 CLI 包装适配版

为 Cobra / oclif / 自研框架补一层导出器或离线生成器。

适合已有大量命令行工具、暂时不想整体迁移框架的团队。

  • 保留现有 CLI 运行时,不阻断业务迭代
  • 优先覆盖高价值命令面,降低一次性改造风险
  • 便于按产品线逐步推广,而不是全量重写

OpenCLI → MCP Bridge 自动化版

OpenCLI 产物 + schema diff + 文档生成 + MCP 适配层。

适合希望同时打通 CLI 文档、Agent 工具和平台治理的基础设施团队。

  • 一份描述驱动多个下游消费者,减少重复建模
  • 更容易把内部 CLI 纳入 agent platform 的能力目录
  • 适合做长期契约治理,而不只是一次性文档补齐

参考仓库(实时调研)

为什么选择我们

不把 draft 当成熟标准卖

会明确告诉你哪些能力可以现在用,哪些地方还必须保留适配层和回滚余地

兼顾 CLI 与 Agent 两端

不是只导出一个 JSON 文件,而是把文档、MCP、CI 与消费侧一起设计清楚

增量式改造

优先从一个高价值 CLI 做试点,避免一次性重写整个命令行产品线

工程治理优先

把 schema diff、命名规范、破坏性变更检测纳入交付,而不是停留在概念验证

— CONTACT

需要帮忙落地 OpenCLI?

我们提供专业的落地与运维服务

联系咨询 →