# gt: General Translation CLI tool: Démarrage rapide
URL: https://generaltranslation.com/fr/docs/cli/quickstart.mdx
---
title: Démarrage rapide
description: Découvrez à quoi sert la CLI de General Translation, quand l’utiliser et comment traduire votre premier projet.
related:
  links:
    - /docs/cli/guides/generating-translations
    - /docs/cli/guides/configuring
    - /docs/cli/guides/managing-translations
    - /docs/cli/guides/using-auto-jsx

---

La CLI de General Translation (`gt`) configure l’internationalisation et traduit votre projet depuis la ligne de commande.

Elle fonctionne avec [`gt-react`, `gt-next` et `gt-react-native`](/docs/react/overview), avec des bibliothèques i18n tierces comme `next-intl` et `i18next`, ainsi qu’avec des fichiers autonomes tels que JSON, YAML, Markdown et MDX.

## Ce que fait la CLI [#what-it-does]

La CLI vous donne un accès direct à :

* **Configuration** pour installer les dépendances, intégrer votre framework et créer un `gt.config.json`.
* **Traduction** pour envoyer votre contenu source à l’API General Translation et enregistrer les résultats dans votre base de code ou sur le CDN.
* **Briques de CI** pour téléverser, mettre en file d’attente et télécharger des traductions à différentes étapes du pipeline.
* **Validation** pour vérifier votre projet afin de détecter les erreurs de traduction sans appeler l’API.

## Quand utiliser la CLI [#when-to-use]

Utilisez la CLI lorsque vous souhaitez :

* Configurer un nouveau projet pour la traduction à l’aide d’un assistant.
* Traduire votre projet dans le cadre d’un build ou d’un pipeline CI.
* Traduire des fichiers de contenu autonomes sans ajouter de bibliothèque de framework.
* Conserver les traductions dans le contrôle de version avec votre contenu source.

## Démarrage rapide [#quickstart]

Installez `gt`, configurez votre projet et lancez votre première traduction. Vous devez disposer d’un projet existant avec un `package.json` et de Node.js installé.

### 1. Installez `gt`

Installez la CLI en tant que dépendance de développement.

<Tabs items={['npm', 'yarn', 'bun', 'pnpm']}>
  <Tab value="npm">
    ```bash
    npm install gt --save-dev
    ```
  </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>

### 2. Configurez votre projet

Lancez l’assistant de configuration pour détecter votre framework, créer un `gt.config.json` et générer des identifiants d’accès lorsque la configuration sélectionnée les requiert.

```bash
npx gt init
```

Dans un monorepo, exécutez la commande depuis l’application que vous souhaitez localiser. L’assistant s’arrête sans modifier de fichiers lorsque vous l’exécutez depuis la racine du workspace.

<Callout type="warn">
  [`gt init`](/docs/cli/reference/commands/init) est un assistant interactif et nécessite un terminal. Dans un environnement CI ou un autre shell non interactif, il peut attendre une saisie, échouer lors de la validation ou se terminer prématurément sans créer `gt.config.json` ni enregistrer les identifiants d’accès. Pour ces environnements, utilisez [Configuration non interactive pour CI](#ci-setup).
</Callout>

L’assistant définit votre paramètre régional par défaut et vos paramètres régionaux cibles, puis choisit l’emplacement de stockage des traductions. Lorsque la configuration sélectionnée nécessite des identifiants d’accès, il peut enregistrer votre clé API et votre ID de projet dans `.env.local`. Consultez [Configurer le CLI](/docs/cli/guides/configuring) pour plus de détails sur la configuration, ou [`gt init`](/docs/cli/reference/commands/init) pour la commande complète.

*Remarque : vous devriez maintenant avoir un `gt.config.json` à la racine de votre projet. Si l’assistant a généré des identifiants d’accès, `.env.local` contient `GT_API_KEY` et `GT_PROJECT_ID`. La configuration Vite avec bundle local ne génère pas d’identifiants d’accès ; ajoutez-les donc à l’étape suivante avant de traduire.*

### 3. Ajoutez votre clé API de production

La commande [`translate`](/docs/cli/reference/commands/translate) nécessite une clé API de production et un ID de projet. L’assistant peut les générer pour vous, ou vous pouvez les créer sur la page [API Keys](https://generaltranslation.com/dashboard). Définissez-les en variables d’environnement pour que la CLI puisse les lire.

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

*Remarque : définissez votre clé API dans une variable d’environnement — ne l’ajoutez jamais à `gt.config.json`.*

### 4. Traduisez votre projet

Exécutez la commande [`translate`](/docs/cli/reference/commands/translate) pour traduire tous les fichiers configurés dans `gt.config.json`, ainsi que les composants inline [`<T>`](/docs/react/reference/components/t) et les entrées de dictionnaire présents dans votre code source.

```bash
npx gt translate
```

Les traductions sont enregistrées dans votre base de code, prêtes à être committées. Exécutez cette commande dans votre pipeline CI avant de lancer votre build de production. Consultez [Génération des traductions](/docs/cli/guides/generating-translations) pour voir le workflow complet.

## Configuration non interactive pour CI [#ci-setup]

L’assistant de configuration nécessite un terminal interactif ; il ne peut donc pas s’exécuter dans CI ni dans d’autres environnements non interactifs. Configurez-les manuellement : committez un `gt.config.json`, fournissez vos identifiants d’accès sous forme de variables d’environnement, puis exécutez [`translate`](/docs/cli/reference/commands/translate) avec cette configuration.

### 1. Ajouter un `gt.config.json`

Créez vous-même le fichier et committez-le afin que la CLI sache quoi traduire. Une configuration minimale définit le paramètre régional source et les paramètres régionaux cibles, ainsi qu’une entrée `files` pour que [`translate`](/docs/cli/reference/commands/translate) ait quelque chose à traiter. L’entrée `gt` ci-dessous stocke localement les traductions du framework (issues de `gt-next`, `gt-react` ou `gt-react-native`) à l’emplacement indiqué.

```json title="gt.config.json"
{
  "$schema": "https://assets.gtx.dev/config-schema.json",
  "defaultLocale": "en",
  "locales": ["fr", "es"],
  "files": {
    "gt": {
      "output": "public/_gt/[locale].json"
    }
  }
}
```

Pour traduire plutôt des fichiers autonomes, ajoutez un type de fichier comme `json` ou `mdx` avec un motif `include`, à la place de l’entrée `gt` (ou en plus de celle-ci). Consultez [Configurer le CLI](/docs/cli/guides/configuring) pour les options de fichier et de stockage, ainsi que la [référence de configuration](/docs/cli/reference/config) pour connaître tous les champs.

### 2. Définissez vos identifiants d’accès

Définissez votre clé API de production et votre ID de projet en variables d’environnement dans les paramètres de secrets de votre fournisseur CI, et non dans un fichier versionné. Créez-les sur la page [API Keys](https://generaltranslation.com/dashboard).

```bash
GT_API_KEY=your-api-key
GT_PROJECT_ID=your-project-id
```

### 3. Exécutez la commande translate

Exécutez [`translate`](/docs/cli/reference/commands/translate) avant de lancer un build de production. Utilisez `--config` pour spécifier votre fichier de configuration.

```bash
npx gt translate --config gt.config.json
```
## Next steps

- /docs/cli/guides/generating-translations
- /docs/cli/guides/configuring
- /docs/cli/guides/managing-translations
- /docs/cli/guides/using-auto-jsx