# gt: General Translation CLI tool: Démarrage rapide
URL: https://generaltranslation.com/fr/docs/cli/quickstart.mdx
Docs index: https://generaltranslation.com/llms.txt
Description: Utilisez la CLI de General Translation pour traduire votre projet depuis la ligne de commande.

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.
* **Accès à l’API** pour des requêtes brutes authentifiées et la découverte OpenAPI intégrée avec [`gt api`](/docs/cli/reference/commands/api).
* **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 20 (ou version ultérieure) 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. Configurer votre projet

Exécutez [`gt init`](/docs/cli/reference/commands/init) pour détecter votre framework, créer `gt.config.json` et, si vous le souhaitez, configurer un projet et une clé de développement. L&#39;assistant vous invite à vous connecter lorsque cette étape le nécessite.

```bash
npx gt init
```

Dans un monorepo, exécutez la commande depuis l&#39;application que vous souhaitez localiser. Si vous la lancez depuis la racine de l&#39;espace de travail, l&#39;assistant s&#39;arrête sans modifier aucun fichier.

<Callout type="warn">
  Sans terminal, [`gt init`](/docs/cli/reference/commands/init) n&#39;affiche aucune invite. S&#39;il manque des réponses, la commande s&#39;arrête avant de modifier des fichiers et indique les options à fournir ; consultez [exécutions headless](/docs/cli/reference/commands/init#headless). Pour la CI, utilisez la [configuration non interactive pour la CI](#ci-setup).
</Callout>

L&#39;assistant définit votre paramètre régional par défaut et vos paramètres régionaux cibles, puis choisit l&#39;emplacement de stockage des traductions. Il peut également écrire une clé de développement et un ID de projet dans `.env.local`. Consultez [`gt init`](/docs/cli/reference/commands/init) pour découvrir la commande complète.

*Remarque : un fichier `gt.config.json` doit maintenant se trouver à la racine de votre projet. La configuration Vite en mode bundle local peut se passer de la connexion et des identifiants ; effectuez l&#39;étape suivante avant de traduire.*

### 3. Vérifiez vos identifiants

La commande [`translate`](/docs/cli/reference/commands/translate) nécessite un ID de projet ainsi que votre connexion enregistrée ou une clé API. Si ces éléments n&#39;ont pas été configurés lors de l&#39;étape d&#39;initialisation, exécutez [`gt login`](/docs/cli/reference/commands/login) et définissez votre ID de projet :

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

(Voir [Identifiants de la CLI](/docs/cli/guides/configuring#credentials).)

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

Dans CI, configurez le projet manuellement : committez un `gt.config.json`, fournissez vos identifiants 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éfinissez la clé API de projet et votre ID de projet en variables d’environnement dans les paramètres de secrets de votre fournisseur CI, et non dans un fichier committé. Créez la clé dans le [Dashboard](/docs/platform/dashboard/reference/api-keys) ou avec [`gt api-key create`](/docs/cli/reference/commands/api-key-create), en lui accordant les autorisations **Files &gt; Write** et **Translation queue &gt; Enabled** (ajoutez **Context &gt; Write** si vous générez du contexte) ; la clé de développement fournie par l&#39;assistant ne suffit pas.

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

## Sitemap

See the full [sitemap](https://generaltranslation.com/sitemap.md) for all pages.