Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.lazylocales.com/llms.txt

Use this file to discover all available pages before exploring further.

The lazylocales CLI is the primary way to interact with LazyLocales. It handles authentication, source file management, translation triggering, and locale file downloads.

Installation

npm install --save-dev lazylocales
Or use it directly with npx:
npx lazylocales <command>

Commands

CommandDescription
translatePush source, translate locally with AI, and write locale files
checkScan codebase for unused/missing translation keys
pushPush the source locale file to LazyLocales
pullCheck status of translated locale files on disk
statusShow translation coverage for all locales
addAdd a new target language to the project
removeRemove a target language from the project
delete-projectPermanently delete the current project
loginAuthenticate with LazyLocales
logoutClear stored credentials
whoamiShow the currently logged-in user
completionPrint shell completion script for tab completion

Global options

All commands support these flags:
FlagDescription
--helpShow help for a command
--versionShow the installed CLI version

Authentication

The CLI uses your login session by default. Credentials are stored in ~/.config/lazylocales/. For CI/CD environments, set the LAZYLOCALES_API_KEY environment variable. The CLI uses it automatically. See CI/CD Setup for details.