让你的 CLI 适合 Agent 使用

提供结构化 Manifest、稳定机器输出、明确命令边界和可复现证据,让编程 Agent 更容易正确调用你的工具。

Agent 需要清楚的操作合同

Agent 不会像熟悉产品的人一样补全隐含上下文。它需要准确安装、无交互认证、稳定输出、可区分的错误和明确的写操作。

机器输出
为需要解析的命令提供 JSON、YAML、CSV 或字段选择。
安全边界
把预览、读取、写入和删除清楚分开,并标出确认节点。
Agent 产物
提供 Skill、AGENTS.md、策略或可生成它们的 Manifest。
版本证据
记录测试版本、环境、命令、退出码和失败路径。

发布一个最小 Manifest

Manifest 不是营销介绍,而是 Agent 和工具目录可以读取的操作数据。先覆盖最常用的安装、输出、认证和代表性命令。

每个命令单独记录风险;来源必须指向官方文档、官方仓库、安装说明或发布页。不要把尚未执行的内容写成 verified。

clifinder.manifest.json
{
  "schemaVersion": 1,
  "name": "example-cli",
  "command": "example",
  "installation": [{ "manager": "brew", "command": "brew install example" }],
  "output": { "structured": true, "formats": ["json"], "flags": ["--json"] },
  "authentication": { "headless": true, "secretEnv": ["EXAMPLE_TOKEN"] },
  "commands": [
    { "command": "example inspect --json", "risk": "R0", "requiresConfirmation": false },
    { "command": "example apply", "risk": "R2", "requiresConfirmation": true }
  ],
  "sources": ["https://example.com/docs/cli"]
}

提交前的维护者检查单

让调用方式可以复现
下面每项都直接影响 Agent 是否能稳定、安全地使用你的 CLI。
  1. 1至少提供一个官方、可固定版本的安装方法。
  2. 2让 --help 和 --version 在无 TTY 环境稳定工作。
  3. 3为核心读取命令提供机器可读输出。
  4. 4将诊断写入 stderr,业务结果写入 stdout。
  5. 5用不同退出码表示参数、认证、网络和目标错误。
  6. 6文档说明最低权限和支持的无界面凭证。
  7. 7提供 dry-run、preview 或 plan,再执行远程写入。
  8. 8把删除和不可逆命令写得明显,并要求显式目标。
  9. 9公开发布记录,说明输出或认证的破坏性变化。
  10. 10附上能复现的测试命令和预期结果。

提交官方来源与使用背景

提交工具名、官方文档或仓库,以及你希望检查的 Agent 工作流。我们不会因为提交就把条目标成 Verified。

开始提交