用途:指导设计或评审供 AI 智能体调用的命令行工具,也适用于为已有面向人类的 CLI 增加智能体支持、将 REST/gRPC API 封装为 CLI、编写 CONTEXT.md/AGENTS.md 或技能文件。不适用于纯库/SDK、仅 GUI/TUI 应用及不暴露给智能体的内部脚本。
核心原则:智能体不是可信操作者,其输入应按不可信用户输入对待,CLI 需作为最后防线。
主要能力与用法:
- 机器可读输出:所有命令支持 --output json,非 TTY 时默认 JSON,错误以结构化对象输出到 stderr。
- 输入加固:拒绝资源 ID 中的 ?、#、%、控制字符,校验路径不逃逸工作目录。
- 原始 JSON 输入:支持 --json 传入完整 API 载荷,优先于其他标志。
- 运行时自省:提供 describe、schema、--help --json 等命令输出参数与类型。
- 上下文控制:用 --fields 字段掩码裁剪响应,分页用 NDJSON 流式输出,默认截断超 1KB 字符串。
- 安全机制:--dry-run 本地校验并预览请求,破坏性操作需 --confirm 或 --force,避免交互式提示。
- 无头认证:优先环境变量、凭据文件、服务账号,不强制浏览器 OAuth。
- 确定性退出码:0 成功、2 参数错误、3 认证失败、4 未找到、5 限流、10 dry-run 通过。
- 上下文文件:随 CLI 提供 SKILL.md、CONTEXT.md、AGENTS.md。
- MCP 接口:可选以 stdio 提供 JSON-RPC 服务,自动生成工具定义。
限制:资料未提供具体安装命令、收费、价格与平台信息;示例代码为 Go 实现模式,实际落地需结合具体语言与 API schema。