Dokumentation

Kul att du tittar in! Om du har några frågor, kontakta oss gärna på hi@localhero.ai.

Snabbstart

Registrera dig och följ dessa steg för att integrera översättningshantering med LocalHero.ai i ditt projekt.

1. Initiera ditt projekt

Detta kommer att fråga efter din API-nyckel och skapa en localhero.json-fil i din projektkatalog,
samt konfigurera GitHub Action för att automatiskt översätta dina i18n-filer. Du hittar din API-nyckel på API-nyckelsidan.
$ npx @localheroai/cli init

2. Konfigurera ditt projekt

Kontrollera den genererade localhero.json-filen och gör eventuella justeringar.
{:projectId=>"your-project-id", :sourceLocale=>"en", :targetLocales=>["es", "fr", "de"], :files=>["config/locales/*.yml", "app/javascript/locales/*.json"]}

3. Commit och push

Commit:a och pusha dina ändringar till ditt 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-kommandon

$ localhero translate

Översätt saknade nycklar i ditt projekt. Kommandot kontrollerar även om det finns nya nycklar
som har lagts till i API:et som saknas lokalt.
Detta kommando körs av GitHub Action.

$ localhero init

Konfigurera ditt projekt för LocalHero.ai. Kommandot kontrollerar om du har en API-nyckel och skapar en localhero.json-fil i din projektkatalog.

$ localhero login

Autentisera med API:et genom din API-nyckel. Detta kommer att spara din API-nyckel till .localhero_key
och lägga till filen i .gitignore om det behövs. Du kan också ställa in din API-nyckel i
miljövariabeln LOCALHERO_API_KEY.

$ localhero pull

Hämta de senaste översättningsuppdateringarna från LocalHero.ai till dina lokala filer. Detta kommando
laddar ner nya eller modifierade översättningar från tjänsten till dina lokala filer.

Använd --verbose för att se detaljerad förloppsinformation.

$ localhero push

Skicka uppdateringar från dina lokala översättningsfiler till LocalHero.ai. Detta kommando laddar upp
nya eller modifierade översättningar från dina lokala filer till tjänsten.

Använd --verbose för detaljerad förloppsinformation och --yes för att hoppa över bekräftelsefrågan.

GitHub Action

Automatisera översättningar i din CI/CD-pipeline med vår GitHub Action.

GitHub action kräver att repository-hemligheten LOCALHERO_API_KEY är inställd.
Du ställer in hemligheten i repository-inställningarna under Settings > Secrets and variables > Actions.

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 }}
        fetch-depth: 0

    - 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