# gtx-cli: General Translation CLI tool: JSON
URL: https://generaltranslation.com/en-US/docs/cli/formats/json.mdx
---
title: JSON
description: How to automatically translate JSON files with General Translation
---

## Overview

`gtx-cli` can be used to automatically translate your project's JSON files, regardless of what i18n library you are using.

<Callout type='info'>
  **Note:** We currently support custom string syntax and formatting for the
  following 3rd-party i18n libraries: `next-intl`, `i18next`. If you are using a
  different i18n library, the translation results may not be accurate for
  strings with custom syntax and formatting (for example, ICU messages). Don't
  see your favorite library? [Please let us
  know](https://github.com/generaltranslation/gt/issues), and we will add it as
  soon as we can!
</Callout>

We will follow these 4 steps:

<Steps>
  <Step>
    Add your environment variables
  </Step>
  <Step>
    Install [`gtx-cli`](/docs/cli)
  </Step>
  <Step>
    Create a `gt.config.json` file
  </Step>
  <Step>
    Run [`gtx-cli translate`](/docs/cli/translate#translate)
  </Step>
</Steps>

<Callout>
  **Tip:**
  Avoid the hassle of using translation files with the [`<T>` component](/docs/react/guides/t).
</Callout>

---

## Step 1: Add your environment variables

Add your production API key and project ID to your environment variables.
This is necessary to use the `gtx-cli` tool.
You get these from the [General Translation dashboard](https://generaltranslation.com/dashboard).

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

## Step 2: Install `gtx-cli`

Install the `gtx-cli` tool in your project.

<Tabs items={['npm', 'yarn', 'bun', 'pnpm']}>
  <Tab value="npm">
  ```bash 
  npm i gtx-cli
  ``` 
  </Tab>
  <Tab value="yarn">
  ```bash 
  yarn add --dev gtx-cli
  ```
  </Tab>

  <Tab value="bun">
  ```bash 
  bun add --dev gtx-cli
  ```
  </Tab>
  <Tab value="pnpm">
  ```bash 
  pnpm add --save-dev gtx-cli
  ```
  </Tab>
</Tabs>

## Step 3: Create a `gt.config.json` file

Create a `gt.config.json` file in the root of your project.

```json title="gt.config.json" copy
{
  "defaultLocale": "en",
  "locales": ["zh", "es", "ja"],
  "files": {
    "json": {
      "include": ["i18n/[locale]/*.json"]
    }
  }
}
```

Feel free to customize the `gt.config.json` file to your needs. See the [configuration](/docs/cli/reference/config) docs for more information.

Update the `json` file format such that the `include` path matches your project structure.

<Callout>Translations will preserve the original string syntax.</Callout>

## Step 4: Add the `gtx-cli translate` command to your build process

Add the `gtx-cli translate` command to your build or CI process before the build command to automatically add translations to your project.

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

This will generate translations for all of your locales and save them to your project.
If you want to commit these files to your repo, you can instead run this command before committing.

You're done! Now your project will automatically update all of your translation JSON files any time your project changes.

---

## Notes

- You can automatically add translations to your project with the [`gtx-cli translate`](/docs/cli/translate#translate) command.
- If you want to commit your translation files, you should run the `gtx-cli translate` command before committing.
- To configure the output path for your translations, see the [configuration](/docs/cli/reference/config) docs.

## Next steps

- See the [usage guide](/docs/cli/reference/usage) for the cli tool.