bird

Usage

代码示例

bird

Description

Authenticate, configure, and operate the Bird API from the command line.

Output is JSON by default; pass --format text for a human-readable card on single-record reads (get, show). Errors and diagnostics go to stderr, never mixed with data on stdout.

Mutations (send, create, test) take input from flags, a JSON body via --body-file ("-" reads stdin), or both — a flag overrides the matching body field. Run a command with --example to print its body shape, --dry-run to preview the request without sending, and --idempotency-key to make a retry safe.

Run "bird commands" to print the whole command tree as JSON.

Channels

Name	Description
email	Send and receive email and manage its deliverability resources
sms	Send SMS and manage its messaging resources
whatsapp	Send WhatsApp messages
voice	Read the call log and statistics, manage what admits a call, and place a test call
realtime	Provision Realtime apps and the keys their clients connect with

Contacts & Audiences

Name	Description
contacts	Manage contacts, identified by email, phone, or external ID
audiences	Group contacts into named audiences to send to
contact-properties	Define the custom fields a contact can carry

Developer

Name	Description
webhooks	Manage outbound webhook endpoints
verify	Send one-time passcodes and check them
lookup	Find out about a recipient before you use it
docs	Search the Bird documentation
request-logs	Inspect your API request logs

Account

Name	Description
auth	Manage Bird API credentials
billing	Inspect billing plans and pricing
support-tickets	Open and follow up on Bird support tickets
members	Manage workspace members
invitations	Manage workspace invitations
organization	Administer the organization a credential belongs to
workspace	Inspect the current workspace and its settings

CLI

Name	Description
config	Inspect CLI configuration
version	Print the CLI version
update	Update the bird CLI to the latest release
commands	Print the full command tree as JSON
mcp	Serve Bird as MCP tools over stdio
whoami	Show the signed-in user (id, email, name)

Examples

代码示例

# Sign in (opens a browser)
bird auth login

# Send an email from a JSON body
bird email send --body-file message.json

# List recent messages and pull their ids
bird email list | jq -r '.data[].id'

Options

Name	Description
--base-url	API base URL (or set BIRD_API_URL)
--format, -f	Output format: json, or text where offered (single-record commands; collections are always JSON) (default json)
--max-retries <n>	Retries after a transient failure, 0 to disable (or set BIRD_MAX_RETRIES) (default 2)