Überblick

gtx-cli kann verwendet werden, um die JavaScript- (JS) und TypeScript- (TS) files Ihres Projekts automatisch zu Übersetzen.

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 beides 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: Konfigurieren Sie die gt.config.json-Datei Ihres Projekts

Erstellen Sie im Projektstammverzeichnis eine gt.config.json-Datei mit folgendem Inhalt:

{
  "defaultLocale": "en",
  "locales": ["es", "fr"],
  "files": {
    "ts": {
      "include": ["docs/[locale]/**/*.ts"]
    }
  }
}

Ändern Sie defaultLocale und locales, damit sie zu den locales Ihres Projekts passen.

Wenn Ihre files JavaScript files sind, können Sie den Schlüssel js anstelle von ts verwenden. Das String-Array im Schlüssel include sollte ein Glob-Muster sein, das alle Ihre JS files abdeckt.

Es sollte den Platzhalter [locale] verwenden, um die locale der Datei zuzuordnen.

Weitere Informationen zur Datei gt.config.json finden Sie in der Dokumentation zur Konfiguration.

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 && <your build command>"
  }
}

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

Fertig! Dein Projekt aktualisiert jetzt automatisch alle deine Markdown files, sobald sich am Projekt etwas ändert.

Hinweise

• Sie können Ihrem Projekt automatisch Übersetzungen mit dem Befehl gtx-cli translate hinzufügen.
• Wenn Sie Ihre Übersetzungs-files committen möchten, sollten Sie den Befehl gtx-cli translate vor dem Commit ausführen.
• Um den Ausgabepfad für Ihre Übersetzungen zu konfigurieren, siehe die Dokumentation zur Konfiguration.

Nächste Schritte

• Siehe den Leitfaden zur Verwendung des CLI-Tools.