Sign inGet Started

面向 agent 的 CLI

bird CLI 是一个为 agent 驱动而构建的单一可执行文件。输出默认为 JSON,错误输出到 stderr,退出码携带失败类别。

开始设置

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

协议

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

后续步骤

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