Documentation

Getting started

Install the CLI, authenticate, and translate your first file.

ParlanceKit translates localization files while preserving placeholders, plural categories, and file structure. You can use it from the command line, from the dashboard, or by connecting a GitHub repository.

Install

pip install parlancekit

Authenticate

Generate an API key in your dashboard settings, then store it locally. You only need to do this once per machine.

parlancekit auth sk-pk-your-key

Translate a file

Pass a source file and one or more target languages. ParlanceKit shows you a plan and asks for confirmation before writing anything or calling the API.

parlancekit translate --input en.json --langs es,fr,de

Add --dry-run to see the plan and exit without translating. Nothing is written and no API call is made.

parlancekit translate --dry-run

Use a config file

Rather than passing flags every time, put your settings in parlancekit.config.json at your project root. Then translate with no arguments at all. You can generate this file from any saved configuration in the dashboard — click Download.

{
  "sourceFile": "src/locales/en.json",
  "sourceLanguage": "en",
  "targetLanguages": ["es", "fr", "de"],
  "targetPattern": "src/locales/{lang}.json",
  "tone": "neutral",
  "glossary": ["ParlanceKit"]
}

parlancekit translate

CLI flags always override values in the config file. The config supplies defaults; flags win.

What happens next

See Configuration for every available option, Commands for the full CLI surface, and GitHub sync if you want ParlanceKit to open pull requests against your repository instead of writing files locally.