# gt: General Translation CLI tool: TypeScript
URL: https://generaltranslation.com/es/docs/cli/formats/ts.mdx
---
title: TypeScript
description: Cómo traducir automáticamente archivos TypeScript y JavaScript con General Translation
---

## Descripción general

`gt` puede usarse para traducir automáticamente los archivos JavaScript (js) y TypeScript (ts) de tu proyecto.

<Callout type="info">
  Se conservarán toda la sintaxis y el formato presentes en los archivos originales
  en los archivos traducidos.
</Callout>

Seguiremos estos 4 pasos:

<Steps>
  <Step>
    Agrega tus variables de entorno
  </Step>

  <Step>
    Instala [`gt`](/docs/cli)
  </Step>

  <Step>
    Configura el archivo [`gt.config.json`](/docs/cli/reference/config) de tu proyecto
  </Step>

  <Step>
    Ejecuta [`gt translate`](/docs/cli/translate#translate)
  </Step>
</Steps>

***

## Paso 1: Añade tus variables de entorno

Añade tu API key de producción y el ID del proyecto a tus variables de entorno.
Esto es necesario para usar la herramienta `gt`.
Puedes obtenerlos en el [dashboard de General Translation](https://generaltranslation.com/dashboard).

```bash title=".env"
GT_API_KEY=<your-api-key>
GT_PROJECT_ID=<your-project-id>
```


## Paso 2: Instala `gt`

Instala la herramienta `gt` en tu proyecto.

<Tabs items={['npm', 'yarn', 'bun', 'pnpm']}>
  <Tab value="npm">
    ```bash
    npm i gt
    ```
  </Tab>

  <Tab value="yarn">
    ```bash
    yarn add --dev gt
    ```
  </Tab>

  <Tab value="bun">
    ```bash
    bun add --dev gt
    ```
  </Tab>

  <Tab value="pnpm">
    ```bash
    pnpm add --save-dev gt
    ```
  </Tab>
</Tabs>

## Paso 3: Configura el archivo `gt.config.json` de tu proyecto

Crea un archivo `gt.config.json` en la raíz de tu proyecto con el siguiente contenido:

```json title="gt.config.json"
{
  "defaultLocale": "en",
  "locales": ["es", "fr"],
  "files": {
    "ts": {
      "include": ["docs/[locale]/**/*.ts"]
    }
  }
}
```

Cambia `defaultLocale` y `locales` para que coincidan con las configuraciones regionales de tu proyecto.

Si tus archivos son de JavaScript, puedes usar la clave `js` en lugar de `ts`. El arreglo de cadenas de la clave `include` debe ser un patrón glob que coincida con todos tus archivos JS.

Debe usar el marcador `[locale]` para que coincida con la configuración regional del archivo.

Consulta la documentación de [configuración](/docs/cli/reference/config) para obtener más información sobre el archivo `gt.config.json`.


## Paso 4: Añade el comando `gt translate` a tu proceso de compilación

Añade el comando `gt translate` a tu proceso de compilación o CI antes del comando de compilación para añadir automáticamente las traducciones a tu proyecto.

```json title="package.json"
{
  "scripts": {
    "translate": "npx gt translate",
    "build": "npm run translate && <your build command>"
  }
}
```

Esto generará traducciones para todas tus configuraciones regionales y las guardará en tu proyecto.
Si quieres hacer commit de estos archivos en tu repositorio, puedes ejecutar este comando antes de confirmar los cambios.

¡Listo! Ahora tu proyecto actualizará automáticamente todos tus archivos TypeScript cada vez que haya cambios en el proyecto.

***


## Notas

* Puedes añadir traducciones automáticamente a tu proyecto con el comando [`gt translate`](/docs/cli/translate).
* Si quieres hacer commit de tus archivos de traducción, debes ejecutar el comando `gt translate` antes de confirmarlos.
* Para configurar la ruta de salida de tus traducciones, consulta la documentación de [configuración](/docs/cli/reference/config).

## Siguientes pasos

* Consulta el [comando translate](/docs/cli/translate) para conocer los detalles de uso de la CLI.