用途
本技能用于 CLI 层面的智能体就绪度工作:让命令行工具能被智能体无人值守地驱动,覆盖机器可读输出、退出码、非交互默认值、结构化错误,以及可修复工作流的迭代闭环。
不适用场景:CLI 与 MCP 选型(先完成架构选型)、MCP 审计与实现、已有厂商 CLI 操作、与智能体契约无关的通用 shell 脚本。
主要能力
五项核心审计检查:--json 等标志存在且 stdout 为纯机器输出;日志、进度、横幅均输出到 stderr;退出码区分成功、用法错误、鉴权、未找到、冲突、校验、可重试失败;无头运行不会因交互提示而阻塞;错误响应包含稳定错误码与 retryable 布尔值。
严重度分级按智能体视角划分:Critical(无法安全解析或存在无 --dry-run/--yes 的破坏性命令)、High、Medium、Low。
最小输出信封为跨命令统一的 JSON:成功为 { "ok": true, "result": {}, "error": null, "schema_version": "v1" };失败含 error.class、code、message、retryable、suggestion。stdout 为数据通道,stderr 为操作通道,退出码表达语义类别,三者需一致。
修复既有 CLI 的构建顺序:先纯 JSON 与流分离,再结构化错误与退出码,再非交互标志与安全默认值,然后迭代反馈循环,之后是发现性,最后是异步/JSONL 任务流。
迭代修复循环适用于智能体生成产物、CLI 校验、被拒后修复重试的场景,如翻译批量、带校验门禁的代码生成、清单/配置/迁移生成、批量导入或同步;每次迭代需返回当前阶段、接受/拒绝/部分、失败位置、是否可重试、下一步命令、剩余进度。一次性读/列/查命令无需此模式。
使用方式
审计工作流:检查顶层帮助与相关子命令,可使用 scripts/audit-cli-help.sh(先读 scripts/audit-cli-help.md)捕获标志与缺失能力;查找 --json、--output json、--quiet、--fields、--jq;在安全只读命令上测试 stdout/stderr 分离;分类各类退出码;探测易提示命令的非交互行为;检查破坏性流程的 --dry-run、--yes、--force;核对帮助是否记录示例、输出字段与退出码;若此前有快照,可用 scripts/diff-cli-help.sh(先读 scripts/diff-cli-help.md)比对命令与标志漂移。
交付物可选:审计报告(按维度评分卡、按严重度排序的问题、命令证据、建议修复、验证命令)、重构后的 CLI 契约、迭代修复循环设计。
参考文档按问题路由:JSON 信封与退出码分类读 references/output-contracts.md;重试、幂等、异步任务、批处理读 references/execution-patterns.md;帮助、鉴权、配置、环境检测读 references/discovery-and-auth.md;迭代修复循环读 references/iterative-cli.md;CLI 与 MCP 选型读 references/mcp-vs-cli-decision.md;代码示例读 references/examples.md;调用方集成读 references/agent-integration.md。
适用场景与限制
适用于新 CLI 的智能体优先约束设计,或既有 CLI 的智能体就绪度审计与修复。内附脚本仅支持只读发现,不能替代 stdout/stderr、退出码、非交互和破坏性流程的人工检查。官方材料未提供定价、平台或版本信息。