Zum Inhalt springen
Esc
↑↓navigieren↵öffnen⌘Jvorschau
Auf dieser Seite

CLI

@billionsend/cli zieht ein E-Mail-Konto aus Ihrem Terminal zu BillionSend um.

@billionsend/cli zieht ein E-Mail-Konto zu BillionSend um. Es liest das Quellkonto, vergleicht es mit Ihrem, wendet den Unterschied an und schreibt einen Bericht. Heute ist Resend die einzige Quelle. Die Schritt-für-Schritt-Anleitung ist Von Resend migrieren. Das Paket ist @billionsend/cli auf npm, und sein Quellcode liegt auf GitHub unter billionsend/billionsend-cli.

Installieren

Erfordert Node 18 oder neuer. Ohne Installation ausführen:

npx @billionsend/cli migrate --from resend

Oder einmal installieren:

npm install -g @billionsend/cli
billionsend --version

Befehle

billionsend migrate --from resend                          # connect, choose resources, plan, confirm, apply
billionsend migrate plan --from resend [--out plan.json]   # read-only: exit 0 nothing to do, 2 changes, 1 error
billionsend migrate apply [plan.json] [--yes]              # apply a saved plan, or plan and apply at once
billionsend migrate status                                 # what the last run created and what is left
billionsend migrate rollback [--yes]                       # delete only what this tool created
  • migrate ist der interaktive Weg. Es fragt nach dem, was fehlt (Schlüssel), lässt Sie Ressourcen auswählen, zeigt den Plan, bittet um Bestätigung, wendet ihn an und gibt eine Zusammenfassung aus.
  • migrate plan zeigt, was sich ändern würde, und schreibt nichts. Vor jedem Schreibzugriff prüft es die Limits Ihres Tarifs über GET /usage und sagt, was nicht passt, zum Beispiel „7 domains to create; the Free plan allows 3“. Außerdem schätzt es die Dauer.
  • migrate apply wendet einen gespeicherten Plan an oder plant und wendet in einem Zug an. Kontakte werden über die E-Mail-Adresse zugeordnet. Alles andere wird über Name, Schlüssel, Endpunkt oder Alias zugeordnet, bei Abweichung aktualisiert und bei Übereinstimmung unverändert gelassen.
  • migrate status zeigt, was der letzte Lauf angelegt hat und was auf der Checkliste noch offen ist. Es braucht keine Schlüssel.
  • migrate rollback löscht nur, was dieses Tool angelegt hat, nie Zeilen, die es nur aktualisiert hat. Es gibt die Liste aus und fragt vorher nach (--yes überspringt die Frage).

Flags

Flag Bedeutung
--from <provider> Quellanbieter. Nur resend.
--from-key-stdin Den API-Schlüssel der Quelle von stdin lesen (erste Zeile).
--from-key <key> API-Schlüssel der Quelle als Argument. In Prozesslisten sichtbar, nutzen Sie daher besser die Umgebungsvariable.
--to-url <url> URL der BillionSend-API. Standard https://api.billionsend.com.
--to-key-stdin Den BillionSend-API-Schlüssel von stdin lesen (zweite Zeile, wenn beide stdin-Flags gesetzt sind).
--to-key <key> BillionSend-API-Schlüssel als Argument. Gleicher Vorbehalt.
--rps <n> Anfragen pro Sekunde an die Quelle. Standard 8, bis zu 100. Das Limit von Resend liegt bei 10 und wird mit Ihrem Produktivversand geteilt. Gehen Sie erst über 10, nachdem Resend Ihr Limit erhöht hat.
--only <a,b> Nur diese Ressourcen umziehen.
--skip <a,b> Diese Ressourcen überspringen.
--on-conflict <mode> Für bereits vorhandene Kontakte: upsert (Standard), skip oder error.
--include-sent Gesendete Newsletter-Versände als Entwürfe importieren. Standardmäßig übersprungen.
--fresh-webhook-secrets Neue Webhook-Signaturgeheimnisse erstellen, statt die alten zu kopieren. Sie werden einmal im Bericht angezeigt.
--fresh Den Fortsetzungsstand verwerfen und alles erneut lesen. Was frühere Läufe angelegt haben, bleibt erhalten, rollback funktioniert also weiterhin.
--out <file> migrate plan: den Plan als JSON schreiben.
--report <file> Den Markdown-Bericht zusätzlich in diesen Pfad schreiben.
-y, --yes Bestätigungen überspringen.
--non-interactive Nie Fragen stellen. Eine fehlende Eingabe beendet mit 1. Automatisch, wenn stdin kein Terminal ist, und mit --json.
--json JSON auf stdout, Fortschritt auf stderr.
-v, --verbose Jede Anfrage protokollieren.
--color <mode>, --no-color auto (Standard), always oder never.
-h, --help / -V, --version Hilfe und Version.

Ressourcen für --only und --skip, in der Reihenfolge, in der sie angewendet werden: domains, properties, topics, segments, contacts, enrichment, broadcasts, templates, webhooks, suppressions, api-keys. enrichment ist der zweite Durchgang, der die Themen-Abos und Eigenschaften jedes Kontakts liest.

Umgebungsvariablen

Variable Bedeutung
RESEND_API_KEY API-Schlüssel der Quelle, voller Zugriff.
BILLIONSEND_API_KEY Ihr BillionSend-API-Schlüssel, voller Zugriff.
BILLIONSEND_BASE_URL URL der BillionSend-API, wie --to-url.
NO_COLOR Farben ausschalten.
FORCE_COLOR Farben auch bei Weiterleitung per Pipe.

Jeder Schlüssel wird in dieser Reihenfolge gesucht: Umgebungsvariable, -stdin-Flag, Argument-Flag und dann, in einem Terminal, eine verdeckte Eingabeaufforderung.

Dateien

Das Tool schreibt diese Dateien neben das Verzeichnis, in dem Sie es ausführen. Sie sind nur für Sie lesbar und enthalten nie einen Schlüssel:

Datei Inhalt
.billionsend/migrate-state.json Was das Tool angelegt hat und wo es stehen geblieben ist, damit ein unterbrochener Lauf fortgesetzt werden kann.
.billionsend/migrate-report.json Der Bericht des letzten Laufs als Daten.
.billionsend/migrate-report.md Derselbe Bericht als Markdown: Zahlen, Checkliste, DNS-Einträge je Domain, eine ID-Zuordnung (IDs der Quell-Themen und -Segmente zu BillionSend-IDs) und manuelle Punkte.

.billionsend/ wird zu .gitignore hinzugefügt, wenn es im aktuellen Verzeichnis eine gibt.

Sicherheit

  • Resend wird nur gelesen. Jede Anfrage an Resend ist ein GET. Schreibzugriffe gehen nur an Ihre BillionSend-API.
  • Schlüssel bleiben im Arbeitsspeicher und sind in jeder Logzeile verborgen. Es gibt keine Telemetrie und keine Update-Prüfung.
  • Ein 401 oder 403 stoppt den Lauf. Das Tool wiederholt oder umgeht das nicht.
  • Ratenlimits werden beachtet. Bei 429 wartet es auf retry-after. Bei einem Server- oder Netzwerkfehler wiederholt es bis zu 5 Mal mit wachsenden Pausen.
  • Abmeldungen bleiben erhalten. unsubscribed und Themen-Abmeldungen werden unverändert kopiert, und niemand wird neu angemeldet. Siehe Abmeldungen.

Exit-Codes

Code Bedeutung
0 Erfolg, oder bei migrate plan: nichts zu tun.
1 Fehler: fehlerhafte Argumente, fehlende Eingabe, abgelehnter Schlüssel.
2 Nur migrate plan: Der Plan enthält Änderungen.
3 Teilweise: Einige Elemente sind fehlgeschlagen. Siehe den Bericht.

Skripte und CI

Wenn stdin kein Terminal ist oder bei --non-interactive oder --json, stellt das Tool nie Fragen. Eine fehlende Eingabe beendet mit 1 und nennt die Variable oder das Flag, das zu setzen ist. Übergeben Sie Schlüssel per Umgebungsvariable oder stdin, nie als Argumente:

export RESEND_API_KEY=re_...
export BILLIONSEND_API_KEY=bs_...

billionsend migrate plan --from resend --out plan.json
# exit 2 means there is something to apply
billionsend migrate apply plan.json --yes

Mit --json enthält stdout nur JSON (den Plan bei migrate plan, den Bericht bei migrate apply), sodass Sie es per Pipe weiterreichen können:

billionsend migrate plan --from resend --json | jq '.counts'

Resend is a registered trademark of Plus Five Five, Inc. BillionSend is not affiliated with or endorsed by Resend.

War diese Seite hilfreich?