Getting started

Install

Add the runtime, the Vite plugin and the compiler, which is where the verbaly command lives. Pick your package manager.

$ pnpm add verbaly @verbaly/vite @verbaly/compiler

The runtime is always the same; the second one depends on your setup. On webpack, Rollup, esbuild or Rspack you install @verbaly/unplugin instead, and Next.js, Nuxt and Astro have their own. See Packages.

Scaffold it in one command

npx verbaly init writes the config, creates the locales/ catalogs and detects your bundler, so it names the plugin you need and where to wire it. It never overwrites anything. Wiring the plugin is yours to do, and it is the next step.

npx verbaly init      # config + locales/ + the integration to install

Add the plugin

import verbaly from '@verbaly/vite';

export default {
  plugins: [verbaly({ sourceLocale: 'es' })],
};

sourceLocale is the language you write in. If you do not list locales, every JSON catalog in locales/ is a language: drop an en.json or pt.json there and Verbaly picks them up. List locales and that list is the whole list, so a file you left behind is ignored.

Write text, not keys

import { t, setLocale } from 'virtual:verbaly';

const saludo = t`Hola ${name}, tienes ${count} mensajes`;

await setLocale('pt'); // lazy-loads pt chunk

In dev, the plugin extracts messages live: your source catalog fills itself, other locales get "" placeholders, and the generated types keep keys and params typed.

Translate and verify

npx verbaly extract   # sync catalogs + types
npx verbaly check     # exit 1 if anything is missing