Documentation
Sign inGet started

CLI for agents

The bird CLI is a single binary built to be driven by an agent. Output is JSON by default, errors go to stderr, and exit codes carry the failure category.

Get set up

The fastest path is to set up your coding agent: paste one prompt and your agent installs the CLI and Bird's skills for you. To install it by hand:
Code example
curl -fsSL https://cli.platform.bird.com/install.sh | sh
bird auth login
bird auth login runs a browser OAuth flow and stores a grant bound to one workspace and its region, so there is no API key and no host to configure. bird auth status always exits 0 and reports valid: true once the token works.

The contract

  • JSON to stdout; errors and diagnostics to stderr; never mixed.
  • Exit codes: 2 invalid input, 3 not found, 4 auth or permission, 1 anything else.
  • Mutations take input from flags, a JSON body via --body-file - (stdin), or both, with the flag winning.
  • --example prints a valid request body, --dry-run previews the request without sending, and --idempotency-key makes a retry safe.

Go deeper