Skip to content

CLI Reference

INFO

CLI version: 0.7.2 · Documentation generated on Mar 19, 2026

Getting Started

Step 1Install the CLI:

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

Step 2Log in to your account:

bash
localekit login --email you@example.com

Step 3Initialize your project:

bash
localekit init ./MyApp

Step 4Check status and translate:

bash
localekit status --detailed
localekit translate --engine deepl --languages de-DE,fr-FR

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

Translation Engines

EngineTypeAPI Key
DeepLCloudDEEPL_API_KEY
OpenAICloudOPENAI_API_KEY
MLXOn-device (Apple Silicon)
Apple Intelligence🖥 macOS app only

Commands

Localization

CommandDescription
localekit initInitialize a LocaleKit configuration file
localekit scanScan directory for localization filesLogin required
localekit statusShow translation status and coverageLogin required
localekit translateTranslate missing localization keysSolo plan
localekit validateValidate localization files for issuesLogin required
localekit diffShow changes since last translationLogin required

Export & Convert

CommandDescription
localekit exportExport localization file to another formatLogin required
localekit convertConvert between localization formatsLogin required

GitHub Integration

CommandDescription
localekit syncTranslate and push localization files to GitHub as a pull requestSolo plan

Authentication

CommandDescription
localekit loginSign in to your LocaleKit account
localekit logoutSign out of your LocaleKit account
localekit whoamiDisplay current user information

Global Options

OptionDescription
--versionShow the current version
--helpShow help information

Default Command

Running localekit without a subcommand defaults to localekit status.

LocaleKit CLI 0.7.2 · Built by Hexagone Studio