Übersicht

gtx-cli kann verwendet werden, um die JSON-Dateien Ihres Projekts automatisch zu übersetzen – unabhängig davon, welche i18n‑Bibliothek Sie verwenden.

Wir folgen diesen 4 Schritten:

Schritt 1: Umgebungsvariablen hinzufügen

Fügen Sie Ihren Produktions-API-Schlüssel und Ihre Projekt-ID zu Ihren Umgebungsvariablen hinzu. Dies ist erforderlich, um das Tool gtx-cli zu verwenden. Sie erhalten diese im General Translation Dashboard.

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

Schritt 2: gtx-cli installieren

Installieren Sie das Tool gtx-cli in Ihrem Projekt.

npm i gtx-cli

yarn add --dev gtx-cli

bun add --dev gtx-cli

pnpm add --save-dev gtx-cli

Schritt 3: Erstellen Sie eine gt.config.json-Datei

Erstellen Sie im Projektstammverzeichnis eine gt.config.json-Datei.

{
  "defaultLocale": "en",
  "locales": ["zh", "es", "ja"],
  "files": {
    "json": {
      "include": ["i18n/[locale]/*.json"]
    },
  },
}

Passen Sie die Datei gt.config.json nach Bedarf an. Weitere Informationen finden Sie in der Dokumentation zur Konfiguration.

Aktualisieren Sie das JSON-Dateiformat, sodass der include-Pfad Ihrer Projektstruktur entspricht.

Schritt 4: Fügen Sie den Befehl gtx-cli translate zu Ihrem Build-Prozess hinzu

Fügen Sie den Befehl gtx-cli translate vor dem Build-Befehl in Ihren Build- oder CI-Prozess ein, um Übersetzungen automatisch in Ihr Projekt zu integrieren.

{
  "scripts": {
    "translate": "npx gtx-cli translate",
    "build": "npm run translate && <Ihr Build-Befehl>"
  }
}

Dies generiert Übersetzungen für all deine locales und speichert sie in deinem Projekt. Wenn du diese files in dein Repo einchecken möchtest, kannst du stattdessen vor dem Commit diesen Befehl ausführen.

Fertig! Dein Projekt aktualisiert nun automatisch alle deine Übersetzungs-JSON-Dateien, sobald sich etwas im Projekt ändert.

Hinweise

• Sie können Ihrem Projekt automatisch Übersetzungen mit dem Befehl gtx-cli translate hinzufügen.
• Wenn Sie Ihre Übersetzungsdateien einchecken möchten, sollten Sie den Befehl gtx-cli translate vor dem Commit ausführen.
• Informationen zum Konfigurieren des Ausgabepfads für Ihre Übersetzungen finden Sie in der Konfigurationsdokumentation.

Nächste Schritte

• Siehe den Leitfaden zur Verwendung des CLI-Tools.