CLI Reference

INFO

CLI version: 0.9.13 · Documentation generated on Apr 14, 2026

Getting Started

Step 1 — Install the CLI:

brew tap hexagone-studio/localekit https://github.com/hexagone-studio/LocaleKit.git
brew install localekit-cli

==> Tapping hexagone-studio/localekit
==> Installing localekit-cli
🍺  /opt/homebrew/Cellar/localekit-cli/0.9.13: 3 files, 12.4MB

Step 2 — Log in to your account:

# password will be prompted securely
localekit login --email you@example.com

Password:
✓ Logged in as you@example.com (Solo tier)

INFO

You can pass --password <password> to skip the interactive prompt, useful for CI/CD pipelines.

Step 3 — Initialize your project:

localekit init ./MyApp

Detected platform: iOS
Detected languages: fr-FR, de-DE, es-ES

Created .localekitrc.yml

Next steps:
  1. Check status:  localekit status
  2. Translate:     localekit translate

Step 4 — Check status and translate:

localekit status --detailed

Platform: iOS
Files: 1

File: Localizable.strings
  Base language: English (US)
  Entries: 42
  Languages: 3

  Coverage by language:
    en-US    [████████████████████] 100% (base)
    fr-FR    [████████████████░░░░]  81% (8 missing)
    de-DE    [██████████████░░░░░░]  76% (10 missing)

localekit translate --engine deepl --languages de-DE,fr-FR

Localizable.strings — 42 keys, 2 languages

  de-DE    [████████████████████] 100% 42/42 ✓
  fr-FR    [████████████████████] 100% 42/42 ✓

✓ Translated 18 keys to 2 languages in 3.2s

See the platform guides for your specific framework, or configure your .localekitrc.yml for your project.

Translation Engines

Engine	Type	API Key
DeepL	Cloud	DEEPL_API_KEY
OpenAI	Cloud	OPENAI_API_KEY
MLX	On-device (Apple Silicon)	—

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.