用途:审计 CLI 是否适合智能体使用,或从零设计面向智能体的命令行契约,也可用于判断工作流应保留 CLI、改用 MCP 还是采用混合方式。
主要能力与检查项:--json 等机器输出存在且 stdout 纯净;日志、进度等走 stderr;退出码能区分用法、认证、未找到、冲突、校验与暂时性失败;无头运行不会因等待交互确认而阻塞;错误响应包含稳定错误码与可重试提示。以上不达标时先修复再添加功能。
设计规则:命令间尽量使用统一的输出信封;stdout 为数据通道,stderr 为操作者通道;命令名与字段类型跨版本保持一致;破坏性操作显式要求 --yes、--force 或 --dry-run;在 --help 中记录示例、输出字段与退出码;可迭代修复的工作流要返回结构化反馈,说明失败项、修复方式与下一步命令。
用法与迭代模式:当需要智能体生成产物、提交、接收校验反馈并多轮改进时(如翻译本地化、代码生成与补丁、配置或迁移生成、导入同步与批量编辑),采用迭代 CLI,每轮告知阶段、产物是否被接受、具体失败位置、是否可重试、下一步命令与剩余进度。若在 CLI、MCP、技能或混合方案间选择,需先阅读 mcp-vs-cli-decision.md。
限制:资料未提供安装命令、运行环境、版本要求与收费信息,也未给出完整代码示例;引用文件包括 output-contracts.md、execution-patterns.md、discovery-and-auth.md、iterative-cli.md、mcp-vs-cli-decision.md、examples.md、agent-integration.md。