Referencia de la CLIVista general

Vista general

El comando verbatra: sus ocho subcomandos, los flags compartidos, cómo lee tu entorno y el contrato de códigos de salida.

Página traducida automáticamente

Esta página fue traducida automáticamente, así que puede contener errores o sonar un poco raro. La versión en inglés es la fuente de la verdad. Lee el original en inglés.

@verbatra/cli incluye el binario verbatra, una envoltura fina sobre @verbatra/sdk. Ocho comandos hacen el trabajo:

ComandoQué hace
initcrea una configuración de verbatra y un .env.example para este proyecto
translatetraduce cada locale de destino una vez y luego sale
watchretraduce en cada cambio del origen hasta que lo interrumpas
checkinforma qué claves faltan o están obsoletas por locale, solo lectura
difflista las claves exactas que se añadirían, se retraducirían o están huérfanas por locale, solo lectura
exportexporta las cadenas sin traducir a un libro de Excel para un traductor humano
importimporta un libro rellenado de vuelta a los archivos de locale
studioarranca Verbatra Studio, el panel local de traducción

Instala e invoca

Instala @verbatra/cli como dependencia de desarrollo y ejecuta el binario a través de tu gestor de paquetes:

pnpm add -D @verbatra/cli
pnpm verbatra translate      # or: npx verbatra translate, yarn verbatra translate

Necesitas Node.js >=22.14.0.

Convenciones compartidas

  • --cwd <path> resuelve la configuración y los archivos de locale desde ese directorio en lugar del actual. Todos los comandos lo aceptan.
  • --config <path> carga ese archivo de configuración en lugar de buscar uno. Todos los comandos excepto init lo aceptan; el orden de búsqueda se describe en Archivo de configuración.
  • --json imprime un resultado legible por máquina en stdout, manteniendo stdout limpio para encadenar: los errores van a stderr. Lo admiten translate, watch, check, diff, export e import; init y studio no.
  • --help y --version imprimen y salen con 0. Un comando o flag desconocido sale con 2.

Archivos de entorno

translate, watch y studio cargan .env.local y luego .env desde el directorio de trabajo antes de ejecutarse. Una variable ya definida en tu entorno real siempre gana. Las claves API se leen solo del entorno, nunca del archivo de configuración ni de un flag: consulta Proveedores. Los comandos de solo lectura (check, diff) y los comandos de libro (export, import) nunca llaman a un proveedor y no cargan archivos .env.

Códigos de salida

El código de salida es el contrato sobre el que ramifica un paso de CI o un script:

CódigoSignificado
0éxito (también --help y --version)
1translate o import terminó pero algunos locales fallaron, check encontró un locale desincronizado, o diff encontró cambios pendientes
2no se pudo ejecutar: un error de toda la ejecución (configuración, origen, proveedor, bloqueo) o un error de uso
130watch o studio fue detenido a la fuerza por una segunda interrupción

La página de cada comando detalla cómo se le aplican estos códigos. Consulta CI y códigos de salida para conectarlos a una canalización.

Edit on GitHub