Vista general
El comando verbatra: sus diez subcomandos, los flags compartidos, cómo lee tu entorno y el contrato de códigos de salida.
Página traducida automáticamente
@verbatra/cli incluye el binario verbatra, una envoltura fina sobre @verbatra/sdk. Diez comandos hacen el trabajo:
| Comando | Qué hace |
|---|---|
init | crea una configuración de verbatra y un .env.example para este proyecto |
translate | traduce cada locale de destino una vez y luego sale |
watch | retraduce en cada cambio del origen hasta que lo interrumpas |
check | informa qué claves faltan o están obsoletas por locale, solo lectura |
diff | lista las claves exactas que se añadirían, se retraducirían o están huérfanas por locale, solo lectura |
doctor | valida la configuración del proyecto e informa de todos los problemas a la vez, sin llamar a un proveedor |
export | exporta las cadenas sin traducir para un traductor humano, como libro de Excel o como un archivo CSV o TSV por locale |
import | importa un libro rellenado o un archivo delimitado de vuelta a los archivos de locale |
studio | arranca Verbatra Studio, el panel local de traducción |
mcp | arranca un servidor MCP por stdio que expone las herramientas de verbatra a un cliente MCP |
Instala e invoca
Instala @verbatra/cli como dependencia de desarrollo y luego ejecuta el binario a través de tu gestor de paquetes:
| Gestor de paquetes | Instalación | Ejecución |
|---|---|---|
| npm | npm install --save-dev @verbatra/cli | npx verbatra <command> |
| pnpm | pnpm add -D @verbatra/cli | pnpm verbatra <command> (o pnpm exec verbatra <command>) |
| yarn | yarn add -D @verbatra/cli | yarn verbatra <command> |
| bun | bun add -d @verbatra/cli | bun run verbatra <command> |
Necesitas Node.js >=22.14.0.
¿Quieres probar un comando antes de instalar? npx @verbatra/cli <command> (npm) o pnpm dlx @verbatra/cli <command> (pnpm) funcionan sin una instalación local previa.
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 exceptoinitlo aceptan; el orden de búsqueda se describe en Archivo de configuración.--jsonimprime un envoltorio legible por máquina en stdout, una línea por registro, manteniendo stdout limpio para encadenar.- Ramifica sobre su campo
ok: un éxito lleva los datos del comando bajoresult, y una ejecución fallida lleva el mismo código de error estable que nombra la línea de stderr. La línea de error legible por humanos va a stderr en ambos casos. - Lo admiten
translate,watch,check,diff,doctor,exporteimport;init,studioymcpno. mcpno escribe nada en stdout en absoluto, porque stdout es el canal del protocolo MCP; consultaverbatra mcp.
- Ramifica sobre su campo
--helpy--versionimprimen y salen con0. Un comando o flag desconocido sale con2.
Archivos de entorno
translate, watch, doctor, studio y mcp 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 entrega (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ódigo | Significado |
|---|---|
0 | éxito (también --help y --version) |
1 | translate o import terminó pero algunos locales fallaron o quedaron parciales, check encontró un locale desincronizado, diff encontró cambios pendientes, o doctor encontró un problema de configuración |
2 | no se pudo ejecutar: un error de toda la ejecución (configuración, origen, proveedor, bloqueo) o un error de uso |
130 | watch, studio o mcp 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