Localazy CLI fits directly into your existing build pipeline without requiring you to change your project structure or source code. You configure it through a localazy.json file in your project root, then call localazy upload and localazy download as steps in your pipeline.
The typical pattern is straightforward: upload runs when new source strings are merged into your development branch, giving translators time to work while you continue building. Download runs when you’re ready to cut a release, pulling in all approved translations automatically.
For GitHub Actions, GitLab CI, and Bitbucket Pipelines, the setup follows the same principle. Store your LOCALAZY_WRITE_KEY and LOCALAZY_READ_KEY as repository secrets, reference them in your pipeline configuration, and define the trigger conditions. For example, uploading only when the source locale file changes, and downloading only on tagged releases.
# GitLab CI example — upload on merge to staging
localazy-upload:
image:
name: localazy/cli:latest
rules:
- changes:
- src/**/locale/en.json
if: '$CI_COMMIT_BRANCH == "staging"'
script:
- localazy upload -w $LOCALAZY_WRITE_KEY -r $LOCALAZY_READ_KEYThe CLI is available as a native binary for all major operating systems, as a Java JAR, and as a Docker image, so it works in any CI environment. Once set up, the pipeline handles translation synchronization automatically — developers commit code, translators work in the Localazy dashboard, and localized builds are produced without anyone managing files manually.
Please help us with improving our documentation.
We appreciate all your feedback.