Übersicht
Der Befehl verbatra: seine acht Unterbefehle, die gemeinsamen Flags, wie er deine Umgebung liest und der Exit-Code-Vertrag.
Maschinell übersetzte Seite
@verbatra/cli liefert das verbatra-Binary, einen dünnen Wrapper über @verbatra/sdk. Acht Befehle erledigen die Arbeit:
| Befehl | Was er tut |
|---|---|
init | eine verbatra-Konfiguration und .env.example für dieses Projekt anlegen |
translate | jedes Ziel-Locale einmal übersetzen, dann beenden |
watch | bei jeder Quelländerung neu übersetzen, bis unterbrochen wird |
check | melden, welche Keys pro Locale fehlen oder veraltet sind, schreibgeschützt |
diff | die genauen Keys pro Locale listen, die hinzugefügt oder neu übersetzt würden oder verwaist sind, schreibgeschützt |
export | unübersetzte Strings in eine Excel-Arbeitsmappe für eine menschliche Übersetzerin exportieren |
import | eine ausgefüllte Arbeitsmappe zurück in die Locale-Dateien importieren |
studio | Verbatra Studio starten, das lokale Übersetzungs-Dashboard |
Installieren und aufrufen
Installiere @verbatra/cli als Dev-Dependency und starte das Binary über deinen Paketmanager:
pnpm add -D @verbatra/cli
pnpm verbatra translate # or: npx verbatra translate, yarn verbatra translateDu brauchst Node.js >=22.14.0.
Gemeinsame Konventionen
--cwd <path>löst die Konfiguration und die Locale-Dateien von diesem Verzeichnis statt vom aktuellen aus auf. Jeder Befehl nimmt es.--config <path>lädt diese Konfigurationsdatei, statt eine zu suchen. Jeder Befehl außerinitnimmt es; die Suchreihenfolge steht in Konfigurationsdatei.--jsongibt ein maschinenlesbares Ergebnis auf stdout aus und hält stdout sauber zum Weiterleiten: Fehler gehen auf stderr.translate,watch,check,diff,exportundimportunterstützen es;initundstudionicht.--helpund--versiongeben aus und enden mit0. Ein unbekannter Befehl oder ein unbekanntes Flag endet mit2.
Umgebungsdateien
translate, watch und studio laden .env.local und dann .env aus dem Arbeitsverzeichnis, bevor sie laufen. Eine bereits in deiner echten Umgebung gesetzte Variable gewinnt immer. API-Keys werden nur aus der Umgebung gelesen, nie aus der Konfigurationsdatei oder einem Flag: siehe Provider. Die schreibgeschützten Befehle (check, diff) und die Arbeitsmappen-Befehle (export, import) rufen nie einen Provider auf und laden keine .env-Dateien.
Exit-Codes
Der Exit-Code ist der Vertrag, auf den ein CI-Schritt oder Skript verzweigt:
| Code | Bedeutung |
|---|---|
0 | Erfolg (auch --help und --version) |
1 | translate oder import lief durch, aber einige Locales schlugen fehl, check fand ein Locale nicht synchron, oder diff fand ausstehende Änderungen |
2 | konnte nicht laufen: ein Fehler des gesamten Laufs (Konfiguration, Quelle, Provider, Lock) oder ein Verwendungsfehler |
130 | watch oder studio wurde durch einen zweiten Interrupt zwangsbeendet |
Jede Befehlsseite erklärt, wie diese Codes für sie gelten. Wie du sie in eine Pipeline einbaust, steht in CI und Exit-Codes.
Edit on GitHub