Sign inGet started

代理的 CLI

bird CLI 是一个单一二进制文件,专为代理驱动而构建。默认输出为 JSON,错误输出到 stderr,退出码携带失败类别信息。

开始设置

最快的方式是设置你的编码代理:粘贴一段提示,你的代理就会为你安装 CLI 和 Bird 的技能。手动安装方式如下:
代码示例
curl -fsSL https://cli.bird.com/install.sh | sh
bird auth login
bird auth login 会运行浏览器 OAuth 流程,并存储绑定到你的工作区及其区域的授权,因此你无需配置 API 密钥或主机。bird auth status 始终以退出码 0 退出,并在令牌有效时报告 valid: truebird whoami 返回已登录用户(ID、邮箱和姓名),即代理所使用的身份,也是 MCP whoami 工具返回的内容。

契约

  • JSON 输出到 stdout;错误和诊断信息输出到 stderr;绝不混合。
  • 退出码:六个语义化退出码,涵盖用法错误、未找到、认证、冲突、瞬时故障和通用回退。完整表格请参见 CLI
  • 变更操作通过标志、--body-file -(stdin)传入的 JSON 主体或两者同时接收输入,标志优先。
  • --example 打印有效的请求体,--dry-run 预览请求但不发送,--idempotency-key 使重试安全。

后续步骤

  • 设置你的编码代理:粘贴一段提示,你的代理就会安装 CLI 和技能。
  • 代理技能:每项技能教会你的代理什么。
  • CLI 参考:所有命令、标志和输出结构。
  • MCP 服务器:与 Bird 相同的接口,以 MCP 工具形式提供,适用于调用工具而非运行 shell 的代理。