Überblick

Dieser Leitfaden führt Sie durch die Verwendung des CLI-Tools von General Translation (gtx-cli), um Ihr Projekt zu übersetzen.

Das CLI-Tool ist mit jeder i18n-Bibliothek kompatibel – egal ob Sie gt-next, gt-react oder Drittanbieter-Bibliotheken wie next-intl oder react-i18next verwenden.

Das CLI-Tool verbindet Ihr Projekt mit dem KI-Übersetzungsdienst von General Translation.

Es gibt mehrere Möglichkeiten, das CLI-Tool zu verwenden. Navigieren Sie zum relevanten Abschnitt für Ihren Anwendungsfall.

Installation

Um das CLI zu installieren, führen Sie den folgenden Befehl aus:

npm i gtx-cli

yarn add --dev gtx-cli

bun add --dev gtx-cli

pnpm add --save-dev gtx-cli

Anwendungsfälle

GT-Projekte übersetzen

Das CLI-Tool kann verwendet werden, um Ihre Projekte zu übersetzen, die gt-next oder gt-react verwenden.

Diese Anleitung setzt voraus, dass Sie Ihren Code bereits gemäß den Tutorials für gt-next oder gt-react eingerichtet haben.

1. Zuerst müssen Sie die GT-Einstellungen Ihres Projekts konfigurieren.

npx gtx-cli konfigurieren

2. Als Nächstes müssen Sie ein Projekt im General Translation Dashboard erstellen.

Nachdem Sie ein Projekt erstellt haben, müssen Sie einen Produktions-API-Schlüssel generieren. Navigieren Sie zur Seite „API Keys“ und klicken Sie auf die Schaltfläche „Create API Key“.

3. Fügen Sie anschließend Ihren API-Schlüssel und die Projekt-ID zu Ihren Umgebungsvariablen hinzu.

GT_API_KEY=<Ihr-API-Key>
GT_PROJECT_ID=<Ihre Projekt-ID>

4. Führen Sie zum Schluss den Übersetzungsbefehl aus.

npx gtx-cli translate

Weitere Informationen zum Befehl translate finden Sie in der API-Referenz.

Sprachdateien übersetzen (i18n-Bibliotheken von Drittanbietern oder eigenständige GT-Projekte)

Das CLI-Tool ermöglicht es, Sprachdateien für i18n-Bibliotheken von Drittanbietern oder mit einer eigenständigen Implementierung von gt-next oder gt-react zu übersetzen.

Die meisten i18n-Bibliotheken verwenden JSON-Dateien, um Übersetzungsdaten zu speichern. Mit dem CLI-Tool können diese JSON-Dateien automatisch in Ihre gewünschten Sprachen übersetzt werden.

1. Zuerst müssen Sie die GT-Einstellungen Ihres Projekts konfigurieren.

npx gtx-cli configure

Dieser Befehl erstellt eine Datei gt.config.json im Stammverzeichnis Ihres Projekts mit einigen grundlegenden Konfigurationseinstellungen, etwa der Standard-locale Ihres Projekts und den unterstützten locales.

2. Als Nächstes müssen Sie ein Projekt im General Translation Dashboard erstellen.

Nachdem Sie ein Projekt erstellt haben, müssen Sie einen Produktions-API-Schlüssel generieren. Navigieren Sie zur Seite „API Keys“ und klicken Sie auf die Schaltfläche „Create API Key“.

3. Fügen Sie anschließend Ihren API-Schlüssel und die Projekt-ID zu Ihren Umgebungsvariablen hinzu.

GT_API_KEY=<your-api-key>
GT_PROJECT_ID=<your-project-id>

4. Führen Sie zum Schluss den Übersetzungsbefehl aus.

npx gtx-cli translate

Sprachdateien für GT‑Projekte generieren

Das CLI‑Tool kann verwendet werden, um Sprachdateien für Projekte zu erzeugen, die gt-next oder gt-react nutzen.

Dieses Szenario ist hilfreich, wenn Sie Ihren eigenen Übersetzungsanbieter einsetzen möchten.

Im Gegensatz zu anderen i18n‑Bibliotheken unterstützen gt-next und gt-react Inline‑Übersetzungen. Das bedeutet, es gibt keine herkömmliche JSON‑Dateistruktur mit Schlüsseln und Werten pro Sprache.

Um Textänderungen nachzuverfolgen, speichern die GT‑Bibliotheken daher die Hashes des Originaltexts im Quellcode.

Diese interne Datenstruktur (mit Hashes) ist schwer zu handhaben. Deshalb stellt das CLI‑Tool einen praktischen Befehl bereit, um Sprachdateien für Ihr Projekt zu generieren.

1. Zuerst müssen Sie die GT‑Einstellungen Ihres Projekts konfigurieren.

npx gtx-cli konfigurieren

Wenn Sie gefragt werden, ob Sie Übersetzungen im GT-CDN (Content Delivery Network) speichern möchten, wählen Sie die Option „Nein“.

2. Führen Sie Folgendes aus:

npx gtx-cli generieren

Dieser Befehl generiert eine Quelldatei für deine Standard-Locale sowie für alle anderen Locales, die du für dein Projekt konfiguriert hast.

Der Inhalt jeder Datei ist identisch und wird mit allen vorhandenen Übersetzungen in deinem Projekt zusammengeführt.

Siehe die API Reference für weitere Informationen zum Befehl generate.

Hinweise

• gtx-cli translate wird verwendet, um automatisch Übersetzungen für Ihr Projekt zu generieren.
• Wenn Sie eine i18n‑Bibliothek eines Drittanbieters verwenden, können Sie bei jeder Änderung Ihres Projekts automatisch alle Ihre Übersetzungs‑JSON files aktualisieren. Fügen Sie einfach den Befehl gtx-cli translate vor dem Build‑Befehl zu Ihrem Build‑ oder CD‑Prozess hinzu, um automatisch Übersetzungen zu Ihrem Projekt hinzuzufügen.

Nächste Schritte

• Weitere Informationen finden Sie in der CLI-API-Referenz.