Documentación

¡Bienvenido, nos alegra verte aquí! Si tienes alguna pregunta, contáctanos en hi@localhero.ai.

Inicio rápido

Regístrate y sigue estos pasos para integrar la gestión de traducciones con LocalHero.ai en tu proyecto.

1. Inicializa tu proyecto

Esto solicitará tu clave de API y creará un archivo localhero.json en la raíz de tu proyecto,
y configurará la acción de GitHub para traducir automáticamente tus archivos i18n. Encuentra tu clave de API en la página Claves de API.

$ npx @localheroai/cli init

2. Configura tu proyecto

Revisa el archivo generado localhero.json y verifica si necesitas realizar ajustes.

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

3. Commit y Push

Haz commit y push de tus cambios a tu repositorio.

$ 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

Comandos CLI

$ localhero translate

Traduce las claves faltantes en tu proyecto y también verifica si hay nuevas claves
que se hayan añadido en la API y que falten localmente.

Este es el comando que ejecutará la acción de GitHub.

Usa --changed-only para traducir solo las claves que se hayan añadido o modificado en git (comparadas con tu rama base). Esto es útil cuando deseas traducir solo los cambios recientes en lugar de todas las traducciones faltantes.

$ localhero init

Configura tu proyecto para LocalHero.ai, verificará si tienes configurada una clave de API
y creará un archivo localhero.json en la raíz de tu proyecto.

$ localhero login

Autentícate con la API usando tu clave de API. Esto guardará tu clave de API en .localhero_key
y añadirá el archivo a .gitignore si es necesario. También puedes configurar tu clave de API en la
variable de entorno LOCALHERO_API_KEY.

$ localhero clone

Descarga todos los archivos de traducción de LocalHero.ai a tu directorio de proyecto local. Este comando es útil cuando tus archivos de traducción no están registrados en el control de versiones.

Por ejemplo, cuando:
- Configuras un nuevo espacio de trabajo
- Obtienes los archivos de traducción más recientes durante el despliegue

$ localhero pull

Descarga las últimas actualizaciones de traducción de LocalHero.ai a tus archivos locales. Este comando
bajará cualquier traducción nueva o modificada desde el servicio a tus archivos locales.

Usa --verbose para ver información detallada del progreso.

$ localhero push

Envía actualizaciones desde tus archivos de traducción locales a LocalHero.ai. Este comando subirá
cualquier traducción nueva o modificada desde tus archivos locales al servicio.

Por defecto, solo se envían los archivos con cambios no registrados en git. Usa --force para enviar todos los archivos sin importar su estado de cambios.

Usa --verbose para obtener información detallada del progreso y --yes para omitir el mensaje de confirmación.

Acción de GitHub

Automatiza las traducciones en tu pipeline de CI/CD con nuestra acción de GitHub.

La acción de GitHub requiere que se configure el secreto del repositorio LOCALHERO_API_KEY.
Puedes configurar el secreto en los ajustes del repositorio bajo 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