Dokumentation - LocalHero.ai

Schnellstart

Registrieren Sie sich und folgen Sie diesen Schritten, um LocalHero.ai in Ihr Projekt zu integrieren.

1. Projekt initialisieren

Dabei wird Ihr API-Schlüssel abgefragt und eine localhero.json-Datei im Projektstamm erstellt,
und die GitHub Action eingerichtet, um Ihre i18n-Dateien automatisch zu übersetzen. Ihren API-Schlüssel finden Sie auf der Seite API-Schlüssel.

$ npx @localheroai/cli init

2. Projekt konfigurieren

Überprüfen Sie die generierte Datei localhero.json und prüfen Sie, ob Anpassungen erforderlich sind.

{
  "schemaVersion": "1.0",
  "projectId": "your-project-id",
  "sourceLocale": "en",
  "outputLocales": [
    "de", "sv", "fr"
  ],
  "translationFiles": {
    "paths": [
      "config/locales/"
    ],
    "pattern": "**/*.{yml,yaml}",
    "ignore": []
  }
}

3. Commit und Push

Committen und pushen Sie Ihre Änderungen in Ihr Repository.

$ git switch -c add-localhero
$ git add localhero.json .github/workflows/localhero-translate.yml
$ git commit -m "Add translation management with LocalHero"
$ git push origin add-localhero

CLI-Befehle

`$ localhero translate`

Übersetzen Sie fehlende Schlüssel in Ihrem Projekt. Es wird auch prüfen, ob neue Schlüssel in der API hinzugefügt wurden, die lokal fehlen.

Dieser Befehl wird von der GitHub Action ausgeführt.

Verwenden Sie --changed-only, um nur Schlüssel zu übersetzen, die in Git hinzugefügt oder geändert wurden (im Vergleich zu Ihrem Basis-Branch). Dies ist nützlich, wenn Sie nur die neuesten Änderungen statt aller fehlenden Übersetzungen übersetzen möchten.

`$ localhero init`

Richten Sie Ihr Projekt für LocalHero.ai ein. Es wird prüfen, ob ein API-Schlüssel eingerichtet ist, und eine Datei localhero.json im Projektstamm erstellen.

`$ localhero login`

Authentifizieren Sie sich mit der API mithilfe Ihres API-Schlüssels. Dieser wird in .localhero_key gespeichert und bei Bedarf zur .gitignore hinzugefügt. Sie können Ihren API-Schlüssel auch in der Umgebungsvariable LOCALHERO_API_KEY festlegen.

`$ localhero clone`

Laden Sie alle Übersetzungsdateien von LocalHero.ai in Ihr lokales Projektverzeichnis herunter. Dieser Befehl ist nützlich, wenn Ihre Übersetzungsdateien nicht in der Versionskontrolle gespeichert sind.

Zum Beispiel:
- Beim Einrichten eines neuen Arbeitsbereichs
- Beim Abrufen der neuesten Übersetzungsdateien während der Bereitstellung

`$ localhero pull`

Laden Sie die neuesten Übersetzungsupdates von LocalHero.ai in Ihre lokalen Dateien herunter. Dieser Befehl lädt neue oder geänderte Übersetzungen vom Dienst in Ihre lokalen Dateien.

Verwenden Sie --verbose, um detaillierte Fortschrittsinformationen anzuzeigen.

`$ localhero push`

Übertragen Sie Updates aus Ihren lokalen Übersetzungsdateien zu LocalHero.ai. Dieser Befehl lädt neue oder geänderte Übersetzungen aus Ihren lokalen Dateien zum Dienst hoch.

Standardmäßig werden nur Dateien mit nicht committeten Git-Änderungen übertragen. Verwenden Sie --force, um alle Dateien unabhängig vom Änderungsstatus zu übertragen.

Verwenden Sie --verbose für detaillierte Fortschrittsinformationen und --yes, um die Bestätigungsaufforderung zu überspringen.

GitHub-Action

Automatisieren Sie Übersetzungen in Ihrer CI/CD-Pipeline mit unserer GitHub-Action.

Die GitHub-Action erfordert, dass das Repository-Geheimnis LOCALHERO_API_KEY gesetzt ist. Sie können das Geheimnis in den Repository-Einstellungen unter Einstellungen > Geheimnisse und Variablen > Aktionen festlegen.

name: Localhero.ai - I18n translation

on:
  pull_request:
    paths:
      - 'config/locales/**'

jobs:
  translate:
    runs-on: ubuntu-latest
    permissions:
      contents: write
      pull-requests: write

    steps:
      - name: Checkout code
        uses: actions/checkout@v4
        with:
          ref: ${{ github.head_ref }}

      - name: Set up Node.js
        uses: actions/setup-node@v4
        with:
          node-version: 18

      - name: Run LocalHero CLI
        env:
          LOCALHERO_API_KEY: ${{ secrets.LOCALHERO_API_KEY }}
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: npx @localheroai/cli translate