Descripción general

Esta guía le mostrará cómo usar la CLI de General Translation (gtx-cli) para traducir su proyecto.

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

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

Existen varias formas de usar la CLI; vaya a la sección correspondiente para su 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

Traducir proyectos de GT

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

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

1. Primero, tendrás que 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 obtener más información sobre el comando translate.

Traducción de archivos de idioma (bibliotecas i18n de terceros o proyectos independientes con GT)

La herramienta 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 de i18n utilizan archivos JSON para almacenar datos de traducción. La herramienta CLI puede usarse para traducir automáticamente estos archivos JSON a los idiomas que necesites.

1. Primero, deberás configurar los ajustes 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 compatibles.

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

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 desea utilizar su 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 por idioma.

Esto implica que, para seguir 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 manejar; por ello, la herramienta de CLI proporciona un comando práctico para generar archivos de idioma para su proyecto.

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

npx gtx-cli configure

Cuando se te pregunte si deseas guardar las traducciones en GT CDN, selecciona la opción «No».

2. Ejecuta:

npx gtx-cli generate

Este comando generará un archivo de origen para tu locale predeterminado y para todos los demás locales que hayas configurado en tu proyecto.

El contenido de cada archivo es el mismo y se fusionará 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 usa para generar automáticamente las traducciones de tu proyecto.
• Si usas una biblioteca de i18n de terceros, puedes actualizar automáticamente todos tus archivos JSON de traducciones cada vez que cambie tu proyecto. Solo agrega el comando gtx-cli translate a tu proceso de compilación o de CD antes del comando de build para añadir automáticamente las traducciones a tu proyecto.

Próximos pasos

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