Überblick

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

Das CLI-Tool ist mit jeder i18n-Bibliothek kompatibel – unabhängig davon, ob Sie gt-next, gt-react oder Drittanbieter-Bibliotheken wie next-intl oder react-i18next einsetzen.

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

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

Installation

Um das CLI-Tool 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

Übersetzen von GT-Projekten

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

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

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

npx gtx-cli configure

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

Nachdem Sie ein Projekt erstellt haben, müssen Sie einen API-Schlüssel für die Produktion 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 Ihre Projekt-ID zu Ihren Umgebungsvariablen hinzu.

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

4. Führen Sie abschließend den Übersetzungsbefehl aus.

npx gtx-cli translate

Weitere Informationen zum Befehl translate finden Sie in der API Reference.

Übersetzen von Sprachdateien (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 nutzen JSON-Dateien zur Speicherung von Übersetzungsdaten. Mit dem CLI-Tool können diese JSON-Dateien automatisch in die gewünschten Sprachen übersetzt werden.

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

npx gtx-cli configure

Dieser Befehl erstellt im Projektstamm eine Datei gt.config.json 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 Ihre 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

Mit dem CLI‑Tool lassen sich Sprachdateien für Projekte erzeugen, die gt-next oder gt-react verwenden.

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

Anders als andere i18n‑Bibliotheken unterstützen gt-next und gt-react Inline‑Übersetzungen. Das bedeutet, es gibt keine klassische 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 unhandlich. 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 configure

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

2. Führen Sie aus:

npx gtx-cli generate

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 dient dazu, automatisch Übersetzungen für Ihr Projekt zu erstellen.
• Wenn Sie eine i18n‑Bibliothek eines Drittanbieters verwenden, können Sie bei jeder Änderung Ihres Projekts automatisch alle Ihre JSON‑Übersetzungsdateien aktualisieren. Fügen Sie dazu einfach den Befehl gtx-cli translate vor dem Build‑Befehl in Ihren Build‑ oder CD‑Prozess ein, um Ihrem Projekt automatisch Übersetzungen hinzuzufügen.

Nächste Schritte

• Weitere Informationen finden Sie in der CLI API Reference.