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 Ihre Codebasis bereits für die Verwendung von gt-next oder gt-react gemäß den Tutorials für gt-next oder gt-react eingerichtet haben.
- Zunächst müssen Sie das CLI-Tool in Ihrem Projekt initialisieren.
- Als Nächstes müssen Sie ein Projekt im General Translation Dashboard erstellen.
Nach dem Erstellen eines Projekts 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 Ihre Projekt-ID zu Ihren Umgebungsvariablen hinzu.
- Führen Sie schließlich den Übersetzungsbefehl aus.
Standardmäßig veröffentlicht das CLI-Tool die Übersetzungen im 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 Befehl translate finden Sie in der API-Referenz.
Übersetzen von Sprachdateien (i18n-Bibliotheken von Drittanbietern oder eigenständige GT-Projekte)
Mit dem CLI-Tool können Sie Sprachdateien für i18n-Bibliotheken von Drittanbietern oder mit einer eigenständigen Implementierung von gt-next oder gt-react übersetzen.
Die meisten i18n-Bibliotheken verwenden JSON-Dateien zur Speicherung von Übersetzungsdaten. Das CLI-Tool kann verwendet werden, um diese JSON-Dateien automatisch in Ihre gewünschten Sprachen zu übersetzen.
- Zunächst müssen Sie das CLI-Tool in Ihrem Projekt initialisieren.
Dieser Befehl erstellt eine gt.config.json-Datei im Stammverzeichnis Ihres Projekts, die einige grundlegende Konfigurationseinstellungen enthält, wie die Standardsprache und die unterstützten Sprachen Ihres Projekts.
- Als Nächstes müssen Sie ein Projekt im General Translation Dashboard erstellen.
Nach dem Erstellen eines Projekts 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 Ihre Projekt-ID zu Ihren Umgebungsvariablen hinzu.
- Führen Sie schließlich den Übersetzungsbefehl aus.
Standardmäßig sucht das CLI-Tool im translationsDir-Verzeichnis, das in Ihrer gt.config.json-Datei angegeben ist, nach Sprachdateien zum Übersetzen.
Es verwendet die in Ihrer gt.config.json-Datei angegebene defaultLocale als Quellsprache.
Es veröffentlicht die Übersetzungen auch im General Translation CDN, damit sie in Ihrem Projekt verwendet werden können.
Wenn Sie dieses Verhalten deaktivieren möchten, fügen Sie dem Befehl das Flag --no-publish hinzu.
Generieren von Sprachdateien für GT-Projekte
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 Inline-Übersetzungen, was bedeutet, dass es keine traditionelle JSON-Dateistruktur gibt, die Schlüssel und Werte für jede Sprache enthält.
Das bedeutet, dass GT-Bibliotheken die Hashes des Originaltextes im Quellcode speichern, um Änderungen am Text zu verfolgen.
Diese interne Datenstruktur (die Hashes enthält) ist schwer zu bearbeiten, und daher bietet das CLI-Tool einen praktischen Befehl zum Generieren von Sprachdateien für Ihr Projekt.
- Zunächst müssen Sie das CLI-Tool in Ihrem Projekt initialisieren.
Wenn Sie gefragt werden "Where are your language files stored?", wählen Sie die Option "Local".
- Führen Sie aus:
Dieser Befehl generiert eine Quelldatei für Ihre Standardsprache und alle anderen Sprachen, die Sie für Ihr Projekt konfiguriert haben.
Der Inhalt für jede Datei ist derselbe und wird mit allen vorherigen Ü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.