Quickstart

Install the loader script

The loader is a tiny <script> that fetches your published label bundle at runtime. It has zero JS dependencies and benefits from infinite CDN caching.

shipeasy i18n install-loader --profile en

The CLI auto-detects your framework and patches the right file:

The command also creates a client SDK key scoped to the project, hard-coded into the script tag. The key only allows reads of published label bundles, nothing else.

Create the source profile

A profile is a locale pair. Create the one matching the language already in your code:

shipeasy i18n profiles create --name en --locale en

For non-English source, use the right BCP-47 code (fr, de, ja, …).

Scan & codemod

Discover strings in your source files. For JSX/TSX we can rewrite them automatically — codemod:

shipeasy i18n scan ./src --rewrite --profile en

The codemod replaces:

<h1>Welcome back</h1>

with:

<h1>{t("welcome_back", "Welcome back")}</h1>

and adds the import. For non-JSX languages (Vue, Svelte, plain HTML, server templates), the scan reports candidates and you wrap them by hand.

A i18n-codemod-review.json report is written at the project root listing strings the codemod skipped (dynamic interpolations, rich HTML, etc.).

Push keys

shipeasy i18n push --profile en --source codemod

Pushes every discovered key to the dashboard. Verify in Shipeasy Translations → Label keys.

Add target locales

Say you want French and German:

shipeasy i18n profiles create --name fr --locale fr
shipeasy i18n profiles create --name de --locale de

Generate AI translations

shipeasy i18n translate --profile fr --ai
shipeasy i18n translate --profile de --ai

Each command creates a draft in the dashboard with proposed translations for every key missing from the target profile. The AI uses the source value, the project tone, the glossary, and any descriptions you've added on each key.

Review

Open Shipeasy Translations → Drafts → fr. You see every key, the source value, and the proposed translation, side by side. Edit any value inline. When you're satisfied, click Merge draft.

Merging promotes the values to the profile. It does not publish — that's a separate, deliberate step.

Publish

shipeasy i18n publish --profile fr
shipeasy i18n publish --profile de

Each publish writes the chunked label bundle to KV and purges the relevant CDN URLs. New copy is live worldwide in seconds.

Switch locale at runtime

The loader reads the active locale from your URL or a cookie. Most frameworks already provide this; the SDK exposes a helper:

import { i18n } from "@shipeasy/sdk/client";
i18n.setLocale("fr");

The loader fetches the new bundle, swaps the strings, and re-renders.