CLI Reference
INFO
CLI version: 0.7.2 · Documentation generated on Mar 19, 2026
Getting Started
Step 1 — Install the CLI:
bash
brew tap hexagone-studio/localekit https://github.com/hexagone-studio/LocaleKit.git
brew install localekit-cliStep 2 — Log in to your account:
bash
localekit login --email you@example.comStep 3 — Initialize your project:
bash
localekit init ./MyAppStep 4 — Check status and translate:
bash
localekit status --detailed
localekit translate --engine deepl --languages de-DE,fr-FRSee the platform guides for your specific framework, or configure your .localekitrc.yml for your project.
Translation Engines
| Engine | Type | API Key |
|---|---|---|
| Cloud | DEEPL_API_KEY | |
| Cloud | OPENAI_API_KEY | |
| On-device (Apple Silicon) | — | |
| 🖥 macOS app only | — |
Commands
Localization
| Command | Description | |
|---|---|---|
localekit init | Initialize a LocaleKit configuration file | |
localekit scan | Scan directory for localization files | Login required |
localekit status | Show translation status and coverage | Login required |
localekit translate | Translate missing localization keys | Solo plan |
localekit validate | Validate localization files for issues | Login required |
localekit diff | Show changes since last translation | Login required |
Export & Convert
| Command | Description | |
|---|---|---|
localekit export | Export localization file to another format | Login required |
localekit convert | Convert between localization formats | Login required |
GitHub Integration
| Command | Description | |
|---|---|---|
localekit sync | Translate and push localization files to GitHub as a pull request | Solo plan |
Authentication
| Command | Description | |
|---|---|---|
localekit login | Sign in to your LocaleKit account | |
localekit logout | Sign out of your LocaleKit account | |
localekit whoami | Display current user information |
Global Options
| Option | Description |
|---|---|
--version | Show the current version |
--help | Show help information |
Default Command
Running localekit without a subcommand defaults to localekit status.
