Gebrauchsanleitung

Übersicht

Diese Anleitung führt Sie durch den Prozess der 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 ist dafür verantwortlich, Ihr Projekt mit dem KI-Übersetzungsdienst von General Translation zu verbinden.

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

Installation

Um das CLI-Tool zu installieren, führe den folgenden Befehl aus:

npm i --save-dev 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 verwenden.

Diese Anleitung setzt voraus, dass Sie Ihren Code bereits gemäß den gt-next oder gt-react Tutorials für die Nutzung 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 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 dann 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 abschließend den Übersetzungsbefehl aus.

npx gtx-cli translate

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

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

Das CLI-Tool ermöglicht es Ihnen, 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. Das CLI-Tool kann verwendet werden, um diese JSON-Dateien automatisch in Ihre gewünschten Sprachen zu übersetzen.

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

npx gtx-cli configure

Dieser Befehl erstellt eine gt.config.json-Datei im Root-Verzeichnis Ihres Projekts, die einige grundlegende Konfigurationseinstellungen wie die Standard-Lokalisierung und unterstützte Sprachen Ihres Projekts enthält.

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 dann 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 abschließend 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 generieren, die gt-next oder gt-react verwenden.

Dieser Anwendungsfall ist nützlich, wenn Sie Ihren eigenen Übersetzungsanbieter verwenden möchten.

Im Gegensatz zu anderen i18n-Bibliotheken unterstützen gt-next und gt-react In-Line-Übersetzungen, was bedeutet, dass es keine traditionelle JSON-Dateistruktur mit Schlüsseln und Werten für jede Sprache gibt.

Das bedeutet, dass zur Nachverfolgung von Textänderungen die GT-Bibliotheken die Hashes des Originaltexts im Quellcode speichern.

Diese interne Datenstruktur (die Hashes enthält) ist schwer zu handhaben, daher bietet das CLI-Tool einen praktischen Befehl, 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 auf dem 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 Ihre Standard-Lokalisierung sowie für alle anderen Lokalisierungen, die Sie für Ihr Projekt konfiguriert haben.

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

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

Hinweise

• gtx-cli translate wird verwendet, um automatisch Übersetzungen für Ihr Projekt zu generieren.
• Wenn Sie eine externe i18n-Bibliothek verwenden, können Sie alle Ihre Übersetzungs-JSON-Dateien automatisch aktualisieren, sobald sich Ihr Projekt ändert. Fügen Sie einfach den Befehl gtx-cli translate zu Ihrem Build- oder CD-Prozess vor dem Build-Befehl hinzu, um Übersetzungen automatisch zu Ihrem Projekt hinzuzufügen.

Nächste Schritte

• Weitere Informationen finden Sie in der CLI API-Referenz.
• Wenn Sie Übersetzungen live während der Entwicklung sehen möchten (ähnlich wie Hot Reload), schauen Sie sich die <T> Komponente an.