# gt: General Translation CLI tool: YAML
URL: https://generaltranslation.com/fr/docs/cli/formats/yaml.mdx
---
title: YAML
description: Comment traduire automatiquement des fichiers YAML avec General Translation
---

## Vue d’ensemble

`gt` permet de traduire automatiquement les fichiers YAML de votre projet, quelle que soit la bibliothèque d’i18n que vous utilisez.

<Callout type="info">
  **Remarque :** Nous prenons actuellement en charge la syntaxe et le formatage
  de chaînes personnalisés pour les bibliothèques d’i18n tierces suivantes :
  `next-intl`, `i18next`. Si vous utilisez une autre bibliothèque d’i18n, les
  résultats de traduction risquent de ne pas être exacts pour les chaînes avec
  une syntaxe et un formatage personnalisés (par exemple, les messages ICU).
  Votre bibliothèque préférée n’apparaît pas ici ? [Faites-le-nous
  savoir](https://github.com/generaltranslation/gt/issues), et nous l’ajouterons
  dès que possible !
</Callout>

Nous allons suivre ces 4 étapes :

<Steps>
  <Step>
    Ajoutez vos variables d’environnement
  </Step>

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

  <Step>
    Créez un fichier `gt.config.json`
  </Step>

  <Step>
    Exécutez [`gt translate`](/docs/cli/translate#translate)
  </Step>
</Steps>

***

## Étape 1 : Ajoutez vos variables d’environnement

Ajoutez votre clé API de production et l’ID de votre projet à vos variables d’environnement.
Cela est nécessaire pour utiliser l’outil `gt`.
Vous les trouverez dans le [tableau de bord General Translation](https://generaltranslation.com/dashboard).

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


## Étape 2 : Installer `gt`

Installez l’outil `gt` dans votre projet.

<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>

## Étape 3 : Créez un fichier `gt.config.json`

Créez un fichier `gt.config.json` à la racine de votre projet.

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

N’hésitez pas à personnaliser le fichier `gt.config.json` selon vos besoins. Consultez la documentation de [configuration](/docs/cli/reference/config) pour en savoir plus.

Mettez à jour le fichier `yaml` afin que le chemin `include` corresponde à la structure de votre projet. Les extensions `.yaml` et `.yml` sont toutes deux prises en charge.

<Callout>Les traductions conserveront la syntaxe de la chaîne d’origine.</Callout>


## Étape 4 : Ajoutez la commande `gt translate` à votre processus de build

Ajoutez la commande `gt translate` à votre processus de build ou d’intégration continue avant la commande de build afin d’ajouter automatiquement les traductions à votre projet.

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

Cela générera des traductions pour tous vos paramètres régionaux et les enregistrera dans votre projet.
Si vous souhaitez ensuite inclure ces fichiers dans un commit de votre dépôt, exécutez plutôt cette commande avant de valider.

C&#39;est terminé ! Désormais, votre projet mettra automatiquement à jour tous vos fichiers de traduction YAML chaque fois qu&#39;il sera modifié.

***


## Métadonnées par clé

Vous pouvez associer à chaque chaîne des instructions de traduction par clé à l’aide d’un fichier `.metadata.yaml` associé. Cela vous permet de fournir du contexte, des limites de caractères et le contexte du code source pour des clés spécifiques sans modifier le fichier source.

```yaml title="translations.yaml"
nav:
  home: "Home"
  bank: "Bank"
  save: "Save"
alerts:
  new_lead: "You have a new lead!"
```

```yaml title="translations.metadata.yaml"
nav:
  bank:
    context: "Berge — le bord d'une rivière. PAS un établissement financier."
  save:
    context: "Terme sportif — un gardien de but qui arrête un tir. PAS une sauvegarde de données."
    maxChars: 12
alerts:
  new_lead:
    context: "Contexte ventes/CRM. Un 'lead' est un client potentiel."
    maxChars: 30
```

Toutes les clés n’ont pas besoin de métadonnées — ajoutez uniquement des entrées pour les clés qui nécessitent des instructions de traduction spécifiques.

Consultez la [référence des métadonnées par clé](/docs/cli/reference/keyed-metadata) pour obtenir la liste complète des champs pris en charge.

***


## Remarques

* Vous pouvez ajouter automatiquement des traductions à votre projet avec la commande [`gt translate`](/docs/cli/translate#translate).
* Si vous souhaitez valider vos fichiers de traduction dans Git, vous devez exécuter la commande `gt translate` avant de faire le commit.
* Pour configurer le chemin de sortie de vos traductions, consultez la documentation de [configuration](/docs/cli/reference/config).
* Les extensions `.yaml` et `.yml` sont toutes deux prises en charge.

## Étapes suivantes

* Consultez la [commande translate](/docs/cli/translate) pour en savoir plus sur son utilisation en CLI.
* Découvrez les [métadonnées par clé](/docs/cli/reference/keyed-metadata) pour les consignes de traduction associées à chaque clé.