Sign inGet Started

CLI

Kirim email pertama Anda dari terminal macOS atau Linux: instal bird CLI, login sekali, lalu kirim. Anda tidak perlu menyalin kunci API.

1. Instal

Contoh kode
curl -fsSL https://cli.bird.com/install.sh | sh
Jalankan bird version untuk memastikan instalasi berhasil. Untuk Windows dan opsi instalasi lainnya, lihat Instal CLI.

2. Login

Contoh kode
bird auth login --scope emails:write
Perintah ini membuka halaman persetujuan di browser tempat Anda memilih workspace dan menyetujui izin. Scope emails:write memungkinkan langkah 3 mengirim. Tanpa scope tersebut, bird auth login meminta akses baca-saja dan pengiriman ditolak. CLI menyimpan token OAuth yang terikat workspace di ~/.config/bird/credentials.json, memperbarui token saat diperlukan, dan mencatat region workspace.

3. Kirim email

Kirim dari domain onboarding bersama Bird ke alamat sandbox delivered@messagebird.dev: tanpa verifikasi domain, tanpa kotak surat asli.
Contoh kode
bird email send \
  --from onboarding@messagebird.dev \
  --to delivered@messagebird.dev \
  --subject "Hello from Bird" \
  --html "<p>My first Bird email.</p>"
CLI mencetak pesan yang diterima sebagai JSON. Field *_count melacak penerima melalui status pengiriman. Dalam respons awal, satu penerima diterima dan belum ada yang terkirim:
Contoh kode
{
  "id": "em_01ky7ma8y2es1s2akzk53tmjn0",
  "status": "accepted",
  "category": "marketing",
  "from": { "email": "onboarding@messagebird.dev" },
  "to": [{ "email": "delivered@messagebird.dev" }],
  "subject": "Hello from Bird",
  "accepted_count": 1,
  "processed_count": 0,
  "delivered_count": 0,
  "deferred_count": 0,
  "bounced_count": 0,
  "complained_count": 0,
  "rejected_count": 0,
  "open_count": 0,
  "click_count": 0,
  "track_opens": true,
  "track_clicks": true,
  "created_at": "2026-07-23T13:58:20.866Z"
}
--to dapat diulang untuk beberapa penerima, --text mengirim isi teks biasa, dan --dry-run mencetak permintaan yang telah diselesaikan tanpa mengirimnya.

4. Periksa hasilnya

accepted berarti Bird menerima pesan dan mengirimkannya secara asinkron. Baca kembali berdasarkan ID em_ dan pantau statusnya hingga mencapai delivered:
Contoh kode
bird email get em_01ky7ma8y2es1s2akzk53tmjn0
Tambahkan --format text untuk kartu yang mudah dibaca manusia sebagai pengganti JSON.
Setiap perintah menulis JSON ke standard output secara default. Error menggunakan respons kesalahan JSON pada standard error, dan exit code mengidentifikasi kategori kegagalan. Lihat CLI untuk agen untuk kontrak lengkapnya.

Langkah selanjutnya