Sign inGet Started

CLI

Envoyez votre premier e-mail depuis un terminal macOS ou Linux : installez le bird CLI, connectez-vous une fois et envoyez. Vous n'avez pas besoin de copier une clé API.

1. Installer

Exemple de code
curl -fsSL https://cli.bird.com/install.sh | sh
Exécutez bird version pour confirmer que l'installation a réussi. Pour Windows et les autres options d'installation, consultez Installer le CLI.

2. Se connecter

Exemple de code
bird auth login --scope emails:write
Cela ouvre une page de consentement dans le navigateur où vous choisissez un espace de travail et approuvez l'autorisation. Le scope emails:write permet à l'étape 3 d'envoyer. Sans lui, bird auth login demande un accès en lecture seule et l'envoi est refusé. Le CLI stocke un jeton OAuth lié à l'espace de travail dans ~/.config/bird/credentials.json, le rafraîchit au besoin et enregistre la région de l'espace de travail.

3. Envoyer un e-mail

Envoyez depuis le domaine d'intégration partagé de Bird vers l'adresse sandbox delivered@messagebird.dev : aucune vérification de domaine, aucune boîte aux lettres réelle nécessaire.
Exemple de code
bird email send \
  --from onboarding@messagebird.dev \
  --to delivered@messagebird.dev \
  --subject "Hello from Bird" \
  --html "<p>My first Bird email.</p>"
Le CLI affiche le message accepté en JSON. Les champs *_count suivent les destinataires à travers les états de livraison. Dans la réponse initiale, un destinataire est accepté et aucun n'est livré :
Exemple de code
{
  "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 est répétable pour plusieurs destinataires, --text envoie un corps en texte brut, et --dry-run affiche la requête résolue sans l'envoyer.

4. Vérifier le résultat

accepted signifie que Bird a accepté le message et le livre de manière asynchrone. Relisez-le par son ID em_ et observez le statut atteindre delivered :
Exemple de code
bird email get em_01ky7ma8y2es1s2akzk53tmjn0
Ajoutez --format text pour une fiche lisible au lieu de JSON.
Chaque commande écrit du JSON sur la sortie standard par défaut. Les erreurs utilisent une réponse d'erreur JSON sur la sortie d'erreur standard, et les codes de sortie identifient les catégories d'échec. Consultez le CLI pour agents pour le contrat complet.

Étapes suivantes