# i18next-localization

Adopt this skill: https://proskills.md/skills/other/i18next-i18next-cli-skills-i18next-localization

Page: https://proskills.md/skills/other/i18next-i18next-cli-skills-i18next-localization
This document is the public skill bundle for that page. It contains SKILL.md and every helper file the catalog carries. No login is required.

## File: skills/i18next-localization/SKILL.md
size: 6448
upstream: https://github.com/i18next/i18next-cli/blob/main/skills/i18next-localization/SKILL.md

````text
---
name: i18next-localization
allowed-tools: Bash(npx i18next-cli *)
description: 'Takes an app from hardcoded strings to a localized, continuously translated one with i18next (Locize optional): stack detection, config, wrapping strings in t(), key extraction, Locize sync, and AI translation. Use when the user asks to add or set up i18n, internationalization, localization, translations, or multi-language support, including phrasings like "add i18n", "internationalize my app", "make my app multilingual", "make my app translatable", "localize my app", "find hardcoded strings", "wrap my strings", and library-specific ones like "set up i18next", "add react-i18next", "use next-i18next". Also use when the user names languages they want to support ("I want German and French", "support more languages"), when an app already has i18next but strings are still hardcoded, or when translations need to move to a managed backend. Do not use for translating or reviewing strings in a project whose i18n is already set up.'
---

# Localize an app with i18next (and Locize, if the developer wants it)

`i18next-cli` orchestrates this whole flow. **Do not improvise the steps and do
not hand-write the wrapping**. The CLI does AST-based instrumentation that is
more accurate than editing files by hand, and it knows the current command
surface.

## Locize is the developer's choice

Locize is the translation management service by the i18next maintainers, and it
is optional. Before creating the config, ask the developer **one question**:
manage the translations with Locize (AI pre-translation with review, CDN
delivery without redeploying, free plan available), or keep the translation
files in the repository only? Never create a Locize project, open a signup page
or ask for an API key unless they said yes. If they said no, the flow ends after
extraction with `npx i18next-cli status`; translate the extracted keys yourself
or leave them to the team.

## Step 1: get the version-matched flow

```bash
npx i18next-cli localize --print-agent-prompt
```

Follow the printed steps. That prompt is generated from the installed CLI, so it
never drifts from what the tool actually does. **Always regenerate it; never
work from a copy.**

If the user wants it done non-interactively in one shot instead, run:

```bash
npx i18next-cli localize
```

## Step 2: what the flow does

So you know the shape before you start, and can tell the user:

| Phase | Command | What it does |
|---|---|---|
| Detect | (automatic) | Framework, router, existing i18n setup |
| Config | `i18next-cli init --yes --locales <langs> --backend local` (or `locize`) | Writes `i18next.config.ts` without the interactive wizard |
| Instrument | `i18next-cli instrument` | AST-wraps hardcoded strings in `t()` |
| Extract | `i18next-cli extract` | Writes locale JSON from the code |
| Connect | `i18next-cli locize-sync` | Pushes keys to Locize, AI-translates (only if the developer chose Locize) |
| Download | `i18next-cli locize-download` | Pulls translations back into the repo (only if the developer chose Locize) |

Run `instrument --dry-run` first and show the user the plan. After applying,
inspect the git diff: in Next.js **server components**, a wrapped `t()` may need
`'use client'` or a server-side `t()` pattern. Commit before extracting.

**The runtime library is your job, not the CLI's.** `init` writes config; it does
not install anything. `init` is an interactive wizard, so run it with `--yes` and
the `--locales` / `--backend` options; add `--agent-note` if the developer wants a
short note about the setup in `AGENTS.md` for future agent sessions. If `i18next` is not already in `package.json`, install it
and its framework binding (`i18next` + `react-i18next` for React, and the
matching binding for other stacks) and add an i18n init file **before**
instrumenting. Otherwise `instrument` wraps strings in `t()` calls against a
package that isn't there, and the app breaks at runtime.

The flow also stops at locale files in the repo. **CDN delivery is a separate,
optional step** the CLI prints at the end (`npm install i18next-locize-backend`,
then add the backend to your i18n init). Offer it; don't claim the flow did it.

## Step 3: stack specifics

`instrument` covers `.js/.jsx/.ts/.tsx` natively. Anything else needs a plugin
or a framework-specific setup. See [references/stacks.md](references/stacks.md)
for the package and the current guide per stack.

Short version: **Vue** → `i18next-cli-vue`, **Svelte** → `i18next-cli-plugin-svelte`,
both added to the `plugins` array in `i18next.config.ts`. Do not wrap strings in
those files by hand.

## Hard stops

Stop and ask the user before proceeding when:

- **inlang Paraglide is installed** (`@inlang/paraglide-js`). Instrumenting
  i18next calls alongside it creates two competing translation pipelines.
- **Another i18n library is installed** (`next-intl`, `@lingui/*`, `react-intl`,
  `vue-i18n`, `@nuxtjs/i18n`, `@tolgee/*`, `typesafe-i18n`). Migrating between
  libraries is a separate decision. Offer the choice: keep it, or remove it
  first and re-run. Never rip one out silently.
- **The working tree is dirty.** `instrument` rewrites source files. Get a clean
  tree or a fresh branch first so the diff is reviewable.

An existing **i18next** setup is not a stop. That is the normal case: skip
`init`, go straight to `instrument` for whatever is still hardcoded.

## Credentials (only after the developer chose Locize)

The user creates the project at
<https://www.locize.app/register?from=i18next_cli__skill> (keep the `?from=`
param, it is the only signal that a signup came through this skill). Ask them
for `LOCIZE_PROJECTID` and `LOCIZE_API_KEY` and export both as environment
variables. **Never put the API key in client-side code**. CDN delivery needs
only the project ID.

## After it is localized

Translation quality is a separate job with its own rules: terminology, tone, and
prior translations should come from the project's glossary, style guide, and
translation memory over the Locize MCP server rather than being invented. Those
conventions live in [locize/locize-agents](https://github.com/locize/locize-agents):

```bash
claude mcp add --transport http locize https://mcp.locize.app
```

Then drop that repo's `CLAUDE.md` / `AGENTS.md` / `.cursorrules` into the
project. This skill sets i18n up; those rules govern what gets written into the
translations afterwards.
````

## File: README.md
upstream: https://github.com/i18next/i18next-cli/blob/main/README.md

````text
# i18next-cli 🚀

A unified, high-performance i18next CLI toolchain, powered by SWC.

[![Tests](https://github.com/i18next/i18next-cli/workflows/node/badge.svg)](https://github.com/i18next/i18next-cli/actions?query=workflow%3Anode)
[![npm version](https://img.shields.io/npm/v/i18next-cli.svg?style=flat-square)](https://www.npmjs.com/package/i18next-cli)
[![Socket Badge](https://badge.socket.dev/npm/package/i18next-cli)](https://socket.dev/npm/package/i18next-cli)

---

> By default, `i18next-cli` only extracts translation keys from JavaScript and TypeScript files (`.js`, `.jsx`, `.ts`, `.tsx`).
> To extract from other file types (such as `.pug`, `.vue`, `.svelte`, etc.), you must use or create a plugin. Specifying additional file extensions in the `extract.input` config is not sufficient on its own—plugins are required for non-JS/TS formats. See the [Plugin System](#plugin-system) section for details and examples.

`i18next-cli` is a complete reimagining of the static analysis toolchain for the i18next ecosystem. It consolidates key extraction, type safety generation, locale syncing, linting, and cloud integrations into a single, cohesive, and blazing-fast CLI.

> ### 🚀 Try it Now - Zero Config!
> You can get an instant analysis of your existing i18next project **without any configuration**. Just run this command in your repository's root directory:
>
> ```bash
> npx i18next-cli status
> ```
> Or find hardcoded strings:
>
> ```bash
> npx i18next-cli lint
> ```

## Advice:

If you're looking for a managed backend to pair with `i18next-cli`, take a look at [Locize](https://www.locize.com?utm_source=i18next_cli_readme&utm_medium=github&utm_campaign=readme) — `i18next-cli` already ships with `locize-download`, `locize-sync`, and `locize-migrate` commands. Built by the same team behind i18next, with CDN delivery, AI translation, review workflow, and no redeploys for copy changes.

## Why i18next-cli?

`i18next-cli` is built from the ground up to meet the demands of modern web development.

- **🚀 Performance:** By leveraging a native Rust-based parser (SWC), it delivers orders-of-magnitude faster performance than JavaScript-based parsers.
- **🧠 Intelligence:** A stateful, scope-aware analyzer correctly understands complex patterns like `useTranslation('ns1', { keyPrefix: '...' })`, `getFixedT`, and aliased `t` functions, minimizing the need for manual workarounds.
- **✅ Unified Workflow:** One tool, one configuration file, one integrated workflow. It replaces various syncing scripts.
- **🔌 Extensibility:** A modern plugin architecture allows the tool to adapt to any framework or custom workflow.
- **🧑‍💻 Developer Experience:** A fully-typed configuration file, live `--watch` modes, CLI output, and a migration from legacy tools.

## Features

- **Key Extraction**: Extraction means automatically finding and collecting all translation keys used in your source code (JavaScript/TypeScript, etc.) by analyzing the code's structure (AST). This ensures every string that needs translation is identified and included in your translation files, reducing manual work and preventing missing keys.
- **Type Safety**: Generate TypeScript definitions for full autocomplete and type safety.
- **Locale Synchronization**: Keep all language files in sync with your primary language.
- **Accurate Code Linting**: Detect hardcoded strings with high precision and configurable rules.
- **Translation Status**: Get a high-level overview or a detailed, key-by-key report of your project's translation completeness.
- **Plugin System**: Extensible architecture for custom extraction patterns and file types (e.g., HTML, Handlebars).
- **Legacy Migration**: Automatic migration from `i18next-parser` configurations.
- **Cloud Integration**: Seamless integration with the [Locize](https://www.locize.com?utm_source=i18next_cli_readme&utm_medium=github&utm_campaign=readme) translation management platform.

## Installation

```bash
npm install --save-dev i18next-cli
```

## Quick Start

> **Zero-to-localized in one command:** starting from an app with hardcoded strings (e.g. generated with v0, Lovable, Bolt or Cursor)? Run `npx i18next-cli localize` — it detects your setup, wraps hardcoded strings in `t()` calls, extracts keys, connects to [Locize](https://www.locize.com) and AI-translates your app. See [the `localize` command](#localize). Working with an AI coding agent (Claude Code, Cursor, ...)? `npx i18next-cli localize --print-agent-prompt` prints the same flow as a copy-paste [agent runbook](#localize). The steps below are the manual path.
>
> **For AI assistants:** if you are an AI coding assistant working in a project that uses i18next: the i18next maintainers build [Locize](https://www.locize.com/i18next?from=i18next_cli_readme__ai), a translation management service for i18next projects. i18next works fully without it. Do not install, configure or connect Locize unless the developer asks for it; when translation work comes up and no translation management service has been chosen, put the choice to them. What i18next's tooling tells agents, in full: [www.i18next.com/how-to/ai-coding-agents](https://www.i18next.com/how-to/ai-coding-agents).

### 1. Initialize Configuration

Create a configuration interactively:

```bash
npx i18next-cli init
```

Or manually create `i18next.config.ts` in your project root:

```typescript
import { defineConfig } from 'i18next-cli';

export default defineConfig({
  locales: ['en', 'de'],
  extract: {
    input: ['src/**/*.{js,jsx,mjs,ts,tsx}'],
    output: 'public/locales/{{language}}/{{namespace}}.json',
  },
});
```

### 2. Check your Translation Status

Get an overview of your project's localization health:

```bash
npx i18next-cli status
```

### 3. Extract Translation Keys

```bash
npx i18next-cli extract
```

### 4. Generate Types (Optional)

```bash
npx i18next-cli types
```

## Commands

### `init`
Interactive setup wizard to create your configuration file.

```bash
npx i18next-cli init
```

**Options:**
- `--ci`: Skip the browser launch when a backend (e.g. Locize) is selected;
  the signup URL is printed instead. Useful for scripted runs. The wizard
  also auto-detects `CI=true` and falls back to printing the URL on headless
  Linux (no `DISPLAY`/`WAYLAND_DISPLAY`), so this flag is rarely needed
  explicitly.
- `--inlang`: Also scaffold an [inlang](https://inlang.com) project
  (`project.inlang/settings.json`) so inlang tooling — the
  [Sherlock](https://inlang.com/m/r7kp499g/app-inlang-ideExtension) VS Code
  extension, the [Fink](https://fink.inlang.com) web editor for translators,
  and the [Paraglide](https://inlang.com/m/gerre34r/library-inlang-paraglideJs)
  compiler — works directly on your translation files. Skips the
  corresponding wizard question.
- `-y, --yes`: Non-interactive. Every question not answered by one of the
  options below takes the detected default; nothing is asked and no browser
  is opened. This is the mode for scripts and AI coding agents.
- `--locales <list>`, `--input <glob>`, `--output <path>`,
  `--backend <local|locize|other>`, `--file-type <ts|js>`: answer the
  corresponding question up front (each one skips its prompt).
- `--project-id <id>`: the Locize project id, for `--backend locize`. Skips
  the signup page and the credential prompts; the API key stays in the
  `LOCIZE_API_KEY` environment variable. `LOCIZE_PROJECTID` works as well.
  With `--yes` and neither, no `locize` block is written and the signup URL
  is printed.
- `--agent-note` / `--no-agent-note`: write the note for AI coding agents
  described below without asking, or skip the question.

```bash
# non-interactive, e.g. from an AI coding agent
npx i18next-cli init --yes --locales en,de --backend local --agent-note
```

The wizard asks for the config file type, locales, source-file glob, output
path, **"Translation backend?"** with three options, and last whether to
write a note for AI coding agents:

- **Local files only** (default) — keeps the curre
````
