Vue quickstart

Install the CLICopy Anchor Link

npm install --save-dev @verbatra/cli

verbatra is a development tool and never ships in your app. The commands below use npx; with pnpm, yarn, or bun, run pnpm verbatra, yarn verbatra, or bun run verbatra instead.

Add a source locale fileCopy Anchor Link

Skip this step if src/locales/en.json already exists. Otherwise create it with two strings, one of them with a placeholder:

{
  "greeting": "Hello, {name}!",
  "cart": {
    "empty": "Your cart is empty."
  }
}

Scaffold a configCopy Anchor Link

npx @verbatra/cli init --format vue-i18n-json --provider gemini --yes

--format vue-i18n-json is the file format of vue-i18n. init finds your locale files, or writes the pattern src/locales/{locale}.json when there are none yet. --yes takes what init detected instead of prompting. The new verbatra.config.ts translates from en into de; add codes to targetLocales for more languages.

Preview the run without a keyCopy Anchor Link

npx @verbatra/cli translate --dry-run

verbatra: dry run over 1 locale, no provider call
verbatra: de done, 2 would translate
verbatra translate (dry run)
  de: 2 would translate, 0 unchanged
1 succeeded, 0 partial, 0 failed (dry run: nothing written)
[ok] dry run done in 0.0s, nothing written
next: verbatra translate (run it for real)

A dry run builds no provider, so it needs no key, spends nothing, and writes nothing.

TranslateCopy Anchor Link

cp .env.example .env

Open .env and paste your key after GEMINI_API_KEY=. No key yet? Gemini has a free tier: create one in Google AI Studio. Every other provider and its variable is on Providers.

npx @verbatra/cli translate

verbatra sends the two strings to Gemini, checks that every placeholder survived, and writes src/locales/de.json. The wording depends on the model, for example:

{
  "greeting": "Hallo, {name}!",
  "cart": {
    "empty": "Dein Warenkorb ist leer."
  }
}

Check that every locale is in syncCopy Anchor Link

npx @verbatra/cli check

[ok] checking the locales (0.0s)
verbatra check
  de: 0 missing, 0 stale, 2 up-to-date (in sync)
all locales in sync

check calls no provider and exits 1 once a locale falls out of sync, so it can gate a pull request.

Load the locales in your appCopy Anchor Link

Add vue-i18n:

npm install vue-i18n

Then load both files and render the greeting:

import { createApp } from "vue";
import { createI18n } from "vue-i18n";
import App from "./App.vue";
import de from "./locales/de.json";
import en from "./locales/en.json";

const i18n = createI18n({
  legacy: false,
  locale: "de",
  fallbackLocale: "en",
  messages: { en, de },
});

createApp(App).use(i18n).mount("#app");

<template>
  <p>{{ $t("greeting", { name: "Ada" }) }}</p>
</template>

Start your app: the greeting reads Hallo, Ada!.