Descripción general

Esta guía te mostrará cómo usar la herramienta de línea de comandos (CLI) de General Translation (gtx-cli) para traducir tu proyecto.

La CLI es compatible con cualquier biblioteca de i18n, ya sea que uses gt-next, gt-react o bibliotecas de terceros como next-intl o react-i18next.

La CLI se encarga de conectar tu proyecto con el servicio de traducción con IA de General Translation.

Hay varias formas de usar la CLI; navega a la sección pertinente a tu caso de uso.

Instalación

Para instalar la CLI, ejecuta el siguiente comando:

npm i gtx-cli

yarn add --dev gtx-cli

bun add --dev gtx-cli

pnpm add --save-dev gtx-cli

Casos de uso

Traducción de proyectos de GT

La herramienta de CLI se puede usar para traducir tus proyectos que utilicen gt-next o gt-react.

Esta guía asume que ya has configurado tu código para usar gt-next o gt-react según los tutoriales de gt-next o gt-react.

1. Primero, deberás configurar los ajustes de GT de tu proyecto.

npx gtx-cli configure

2. A continuación, deberás crear un proyecto en el dashboard de General Translation.

Después de crear un proyecto, deberás generar una clave de API de producción. Ve a la página "API Keys" y haz clic en el botón "Create API Key".

3. Luego, agrega tu clave de API y el ID de proyecto a tus variables de entorno.

GT_API_KEY=<your-api-key>
GT_PROJECT_ID=<your-project-id>

4. Por último, ejecuta el comando de traducción.

npx gtx-cli translate

Consulta la Referencia de API para más información sobre el comando translate.

Traducir archivos de idioma (bibliotecas i18n de terceros o proyectos independientes de GT)

La herramienta de línea de comandos (CLI) te permite traducir archivos de idioma para bibliotecas i18n de terceros o con una implementación independiente de gt-next o gt-react.

La mayoría de las bibliotecas i18n utilizan archivos JSON para almacenar datos de traducción. La herramienta CLI se puede usar para traducir automáticamente estos archivos JSON a los idiomas que desees.

1. Primero, deberás configurar la configuración de GT de tu proyecto.

npx gtx-cli configure

Este comando creará un archivo gt.config.json en la raíz de tu proyecto con algunas configuraciones básicas, como el locale predeterminado de tu proyecto y los locales admitidos.

2. A continuación, debes crear un proyecto en el dashboard de General Translation.

Después de crear un proyecto, deberás generar una clave de API de producción. Ve a la página "API Keys" y haz clic en el botón "Create API Key".

3. Luego, agrega tu clave de API y el ID de proyecto a tus variables de entorno.

GT_API_KEY=<your-api-key>
GT_PROJECT_ID=<your-project-id>

4. Por último, ejecuta el comando de traducción.

npx gtx-cli translate

Generación de archivos de idioma para proyectos de GT

La herramienta de CLI se puede usar para generar archivos de idioma para proyectos que usan gt-next o gt-react.

Este caso de uso es útil si deseas utilizar tu propio proveedor de traducción.

A diferencia de otras bibliotecas de i18n, gt-next y gt-react admiten traducciones en línea, lo que significa que no existe una estructura tradicional de archivos JSON con claves y valores para cada idioma.

Esto implica que, para rastrear los cambios en el texto, las bibliotecas de GT almacenan los hashes del texto original en el código fuente.

Esta estructura de datos interna (que contiene hashes) es difícil de manipular, por lo que la herramienta de CLI ofrece un comando práctico para generar archivos de idioma para tu proyecto.

1. Primero, tendrás que configurar la configuración de GT de tu proyecto.

npx gtx-cli configure

Cuando se te pregunte si quieres guardar las traducciones en el GT CDN (red de distribución de contenido), selecciona la opción «No».

2. Ejecuta:

npx gtx-cli generate

Este comando generará un archivo fuente para tu locale predeterminado y para todos los demás locales que tengas configurados en tu proyecto.

El contenido de cada archivo es el mismo y se combinará con cualquier traducción previa que tengas en tu proyecto.

Consulta la Referencia de API para obtener más información sobre el comando generate.

Notas

• gtx-cli translate se utiliza para generar automáticamente traducciones para tu proyecto.
• Si usas una biblioteca de i18n de terceros, puedes actualizar automáticamente todos tus files JSON de traducción cada vez que cambie tu proyecto. Solo agrega el comando gtx-cli translate a tu proceso de CD antes del comando de build para añadir automáticamente traducciones a tu proyecto.

Próximos pasos

• Consulta la Referencia de API de la CLI para obtener más información.