Nutzungsanleitung
Nutzungsanleitung für das GT Kommandozeilentool
Überblick
Diese Anleitung führt Sie durch den Prozess der Verwendung des CLI-Tools von General Translation (gtx-cli) zur Übersetzung Ihres Projekts.
Das CLI-Tool ist mit jeder i18n-Bibliothek kompatibel, unabhängig davon, ob Sie gt-next, gt-react oder Bibliotheken von Drittanbietern 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 verschiedene Möglichkeiten, das CLI-Tool zu verwenden. Bitte navigieren Sie zum relevanten Abschnitt für Ihren Anwendungsfall.
Installation
Um das CLI-Tool zu installieren, führen Sie den folgenden Befehl aus:
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.
- Zuerst müssen Sie die GT-Einstellungen Ihres Projekts konfigurieren.
Dieser Befehl generiert automatisch einen API-Schlüssel und eine Projekt-ID für Ihr Projekt über das Dashboard.
Wenn Sie den API-Schlüssel und die Projekt-ID jedoch manuell festlegen möchten, folgen Sie den Schritten 2 und 3 unten.
- 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".
- Fügen Sie dann Ihren API-Schlüssel und die Projekt-ID zu Ihren Umgebungsvariablen hinzu.
- Führen Sie abschließend den Übersetzungsbefehl aus.
Standardmäßig veröffentlicht das CLI-Tool die Übersetzungen auf dem General Translation CDN, sodass sie in Ihrem Projekt verwendet werden können.
Wenn Sie dieses Verhalten deaktivieren möchten (zum Beispiel, wenn Sie Übersetzungen aus einer anderen Quelle laden), fügen Sie dem Befehl das Flag --no-publish hinzu.
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.
- Zuerst müssen Sie die GT-Einstellungen Ihres Projekts konfigurieren.
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.
Dieser Befehl generiert automatisch einen API-Schlüssel und eine Projekt-ID für Ihr Projekt über das Dashboard.
Wenn Sie den API-Schlüssel und die Projekt-ID jedoch manuell festlegen möchten, folgen Sie den Schritten 2 und 3 unten.
- 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".
- Fügen Sie dann Ihren API-Schlüssel und die Projekt-ID zu Ihren Umgebungsvariablen hinzu.
- Führen Sie abschließend den Übersetzungsbefehl aus.
Standardmäßig sucht das CLI-Tool nach zu übersetzenden Dateien entsprechend der files-Eigenschaft in Ihrer gt.config.json-Datei.
Es verwendet die in Ihrer gt.config.json-Datei angegebene defaultLocale als Ausgangssprache.
Übersetzte Dateien werden am entsprechenden Ausgabepfad gespeichert, der in Ihrer gt.config.json-Datei angegeben ist.
Weitere Informationen zur files-Eigenschaft finden Sie in der Konfigurationsdokumentation.
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 (mit Hashes) ist schwer zu handhaben, daher bietet das CLI-Tool einen praktischen Befehl, um Sprachdateien für Ihr Projekt zu generieren.
- Zuerst müssen Sie die GT-Einstellungen Ihres Projekts konfigurieren.
Wenn Sie gefragt werden, ob Sie Übersetzungen auf dem GT CDN speichern möchten, wählen Sie die Option "Nein".
- Führen Sie aus:
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 Befehl generate finden Sie in der API-Referenz.
Hinweise
gtx-cli translatewird verwendet, um automatisch Übersetzungen für Ihr Projekt zu generieren.- Wenn Sie eine i18n-Bibliothek eines Drittanbieters verwenden, können Sie alle Ihre Übersetzungs-JSON-Dateien automatisch aktualisieren, wenn sich Ihr Projekt ändert. Fügen Sie einfach den Befehl
gtx-cli translatezu Ihrem Build- oder CD-Prozess vor dem Build-Befehl hinzu, um automatisch Übersetzungen zu Ihrem Projekt hinzuzufügen.
Nächste Schritte
- Weitere Informationen finden Sie in der CLI-API-Referenz.
- Wenn Sie Live-Übersetzungen in der Entwicklung sehen möchten (denken Sie an Hot Reload), schauen Sie sich die
<T>-Komponente an.