Aperçu
La commande verbatra : ses huit sous-commandes, les options partagées, la lecture de l'environnement et le contrat des codes de sortie.
Page traduite automatiquement
@verbatra/cli fournit le binaire verbatra, une surcouche légère de @verbatra/sdk. Huit commandes font le travail :
| Commande | Rôle |
|---|---|
init | crée une config verbatra et un .env.example pour ce projet |
translate | traduit chaque locale cible une fois, puis termine |
watch | retraduit à chaque changement de la source jusqu'à interruption |
check | signale les clés manquantes ou obsolètes par locale, en lecture seule |
diff | liste les clés exactes qui seraient ajoutées, retraduites ou orphelines par locale, en lecture seule |
export | exporte les chaînes non traduites dans un classeur Excel pour un traducteur humain |
import | réimporte un classeur rempli dans les fichiers de locale |
studio | démarre Verbatra Studio, le tableau de bord local de traduction |
Installation et invocation
Installe @verbatra/cli comme dépendance de développement et lance le binaire via ton gestionnaire de paquets :
pnpm add -D @verbatra/cli
pnpm verbatra translate # or: npx verbatra translate, yarn verbatra translateIl te faut Node.js >=22.14.0.
Conventions partagées
--cwd <path>résout la config et les fichiers de locale depuis ce répertoire au lieu du répertoire courant. Toutes les commandes l'acceptent.--config <path>charge ce fichier de config au lieu d'en chercher un. Toutes les commandes saufinitl'acceptent ; l'ordre de recherche est décrit dans Le fichier de configuration.--jsonaffiche un résultat lisible par machine sur stdout et garde stdout propre pour le piping : les erreurs vont sur stderr.translate,watch,check,diff,exportetimportle prennent en charge ;initetstudionon.--helpet--versionaffichent leur sortie et terminent avec0. Une commande ou une option inconnue termine avec2.
Fichiers d'environnement
translate, watch et studio chargent .env.local puis .env depuis le répertoire de travail avant de s'exécuter. Une variable déjà définie dans ton environnement réel l'emporte toujours. Les clés d'API sont lues uniquement depuis l'environnement, jamais depuis le fichier de config ni une option : voir Fournisseurs. Les commandes en lecture seule (check, diff) et les commandes de classeur (export, import) n'appellent jamais de fournisseur et ne chargent aucun fichier .env.
Codes de sortie
Le code de sortie est le contrat sur lequel une étape CI ou un script se branche :
| Code | Signification |
|---|---|
0 | succès (aussi --help et --version) |
1 | translate ou import a terminé mais certaines locales ont échoué, check a trouvé une locale désynchronisée, ou diff a trouvé des changements en attente |
2 | impossible de s'exécuter : une erreur globale (config, source, fournisseur, verrou) ou une erreur d'utilisation |
130 | watch ou studio a été arrêté de force par une seconde interruption |
Chaque page de commande détaille comment ces codes s'y appliquent. Voir CI et codes de sortie pour les brancher dans un pipeline.
Edit on GitHub