Dokumentasjon

Velkommen, og flott å se deg her! Hvis du har spørsmål, bare ta kontakt med oss på hi@localhero.ai.

Kom i gang

Registrer deg og følg disse trinnene for å integrere oversettelseshåndtering med Localhero.ai i prosjektet ditt.

1. Initialiser prosjektet ditt

Dette vil spørre om API-nøkkelen din og opprette en localhero.json-fil i prosjektets rotmappe,
og sette opp GitHub Action for å automatisk oversette i18n-filene dine. Du finner API-nøkkelen din på API-nøkler-siden.
$ npx @localheroai/cli init

2. Konfigurer prosjektet ditt

Sjekk den genererte localhero.json-filen og se om du trenger å gjøre noen justeringer.
{:projectId=>"your-project-id", :sourceLocale=>"en", :targetLocales=>["es", "fr", "de"], :files=>["config/locales/*.yml", "app/javascript/locales/*.json"]}

3. Commit og push

Commit og push endringene dine til repositoriet ditt. 
$ 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-kommandoer

$ localhero translate

Oversett manglende nøkler i prosjektet ditt, den vil også sjekke om det er nye nøkler som er lagt til i API-et som mangler lokalt.

Dette er kommandoen som vil kjøres av GitHub Action.

$ localhero init

Sett opp prosjektet ditt for LocalHero.ai, den vil sjekke om du har en API-nøkkel konfigurert og opprette en localhero.json-fil i prosjektets rotmappe.

$ localhero login

Autentiser med API-et ved hjelp av API-nøkkelen din. Dette vil lagre API-nøkkelen din i .localhero_key og legge til filen i .gitignore om nødvendig. Du kan også sette API-nøkkelen din i miljøvariabelen LOCALHERO_API_KEY.

$ localhero pull

Hent de nyeste oversettelsesoppdateringene fra LocalHero.ai til dine lokale filer. Denne kommandoen vil laste ned alle nye eller endrede oversettelser fra tjenesten til dine lokale filer.

Bruk --verbose for å se detaljert fremgangsinformasjon.

$ localhero push

Push oppdateringer fra dine lokale oversettelsesfiler til LocalHero.ai. Denne kommandoen vil laste opp alle nye eller endrede oversettelser fra dine lokale filer til tjenesten.

Bruk --verbose for detaljert fremgangsinformasjon og --yes for å hoppe over bekreftelsesdialogen.

GitHub Action

Automatiser oversettelser i CI/CD-prosessen din med vår GitHub Action.

GitHub action krever at repository-hemmeligheten LOCALHERO_API_KEY er satt.
Du setter hemmeligheten i repository-innstillingene 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