ShipEasy Docs

CLI Installation

Install the ShipEasyI18n CLI, authenticate, and initialise your project.

The i18n CLI is the primary way to push strings from your codebase to ShipEasyI18n, run codemods, translate profiles, and publish to the CDN.

Install

npm install -g i18n-cli

Verify the install:

i18n --version
# → i18n 1.0.0

Authenticate

Generate a secret token in the dashboard under Settings → Secret Tokens. Tokens start with i18n_at_.

i18n login --token i18n_at_your_secret_token

This stores the token in ~/.config/i18n/credentials.json on macOS/Linux or %APPDATA%\i18n\credentials.json on Windows.

You can also provide the token via environment variable (preferred for CI):

export ShipEasyI18n_SECRET_TOKEN=i18n_at_your_secret_token

Initialise your project

i18n init

Creates i18n.config.json in your project root:

{
  "key": "i18n_pk_your_key_here",
  "profile": "en:prod",
  "chunks": {
    "index":    ["nav.*", "common.*", "footer.*"],
    "checkout": ["checkout.*", "payment.*"]
  },
  "scan": {
    "include": ["src/**/*.{tsx,jsx,vue,html,erb}"],
    "exclude": ["node_modules", "dist", ".next"]
  }
}

Edit key to match your public API key from the dashboard.

Install Claude Code skill files

i18n init --skills

Installs ShipEasyI18n skill files to .claude/skills/i18n/. These teach Claude Code how to use ShipEasyI18n autonomously — discovering your config, pushing strings, translating profiles, and publishing.

Pre-commit hook

i18n init automatically installs a pre-commit hook at .git/hooks/pre-commit:

#!/bin/sh
i18n validate

This prevents commits that introduce new data-label keys not yet pushed to ShipEasyI18n.

To skip the hook temporarily:

git commit --no-verify -m "wip"