Dokumentation

👋 VĂ€lkommen, 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.
{
  "schemaVersion": "1.0",
  "projectId": "your-project-id",
  "sourceLocale": "en",
  "outputLocales": [
    "de", "sv", "fr"
  ],
  "translationFiles": {
    "paths": [
      "config/locales/"
    ],
    "pattern": "**/*.{yml,yaml}",
    "ignore": []
  }
}

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 clone

Ladda ner alla översÀttningsfiler frÄn LocalHero.ai till din lokala projektkatalog. Detta kommando Àr anvÀndbart nÀr dina översÀttningsfiler inte Àr incheckade i versionskontrollen.

Till exempel nÀr:
- Du sÀtter upp en ny arbetsyta
- Du hÀmtar de senaste översÀttningsfilerna under deploy

$ 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 }}

    - 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