Multilocale Developer Documentation#

Build localization workflows with the Multilocale REST API, command-line interface, signed webhooks, and hosted Model Context Protocol (MCP) server. These guides cover authentication, API resources, translation-file automation, and connections for AI clients.

Start here#

npx multilocale signup --email you@example.com --json

That creates an account and logs you in with no browser and no dashboard visit, which is why it is also the entry point for agents and CI. Then the CLI guide takes it from there.

Quick Links#

• Multilocale CLI — Import, download, and manage translations from the command line
• Rendering translations — Get the files into React, Next.js, Lingui, Android or iOS
• Multilocale REST API — Read and write projects, phrases, and translations
• API authentication — Use a scoped project API key or an operator access token
• Signed webhooks — React to project and phrase changes
• Multilocale MCP server — Use Multilocale from Claude, ChatGPT, Codex, and compatible AI clients

How It Works#

1. Create a project — multilocale projects create my-app --locales en,es,fr, or in the Multilocale dashboard
2. Add translation keys with values in your default language — multilocale add, or multilocale import for a codebase that already has translation files
3. Translate to other languages using AI-powered auto-translation or manual input
4. Integrate translations into your app: multilocale download writes one dictionary file per locale into your repository, and your framework's own i18n runtime renders them

There is no Multilocale runtime library to install — the published package, multilocale, is a CLI that syncs files. See Rendering translations.

Core Concepts#

Projects#

A project groups related translations together. For example, you might have separate projects for your web app, mobile app, and marketing site.

Phrases#

A phrase is a single translatable unit, identified by a key. Each phrase has values in one or more languages.

{
  "key": "welcome_message",
  "value": "Welcome to our app!",
  "language": "en"
}

Locales#

Locales are the languages your project supports. When you add a new locale, Multilocale can auto-translate all existing phrases into that language.