A command-line interface for interacting with the locize localization platform. Currently at version 12.1.1, the `locize-cli` streamlines localization workflows by allowing programmatic management of translation keys and files. It enables tasks such as adding, removing, and retrieving translation entries, as well as downloading published translations in a wide array of formats including JSON, XLIFF, Android, YAML, and more. The project maintains a regular release cadence, with minor patches and dependency updates often occurring on a weekly or bi-weekly basis. A key differentiator is its comprehensive `sync` command, which facilitates bidirectional synchronization between local translation files and the remote locize platform, enabling developers to maintain their existing code setup while keeping translations updated. It also offers a dedicated GitHub Action for seamless integration into CI/CD pipelines, making it an essential tool for automating localization processes for projects utilizing locize. This CLI is primarily used globally and does not provide an API for programmatic JavaScript imports, focusing instead on shell-based execution for routine localization tasks.
npm install locize-cliVerified import paths — ran on the pinned version, not inferred.
This quickstart provides JavaScript code that outputs common `locize-cli` commands for adding, removing, downloading, and synchronizing translation keys and files. It demonstrates how to interact with the locize platform from your terminal, using placeholder environment variables for API keys and project IDs.
Use only letters, numbers, hyphens ('-'), and underscores ('_') when naming your namespaces to ensure cross-platform compatibility.Always use `--ver` followed by the desired version (e.g., `latest`) when referencing translation versions in your commands.
Ensure the desired version on locize is set to auto-publish, or include the `--unpublished true` option in your `sync` command to work with unpublished translations.
Upgrade your Node.js environment to version 22 or higher. You can use a Node.js version manager like `nvm` to easily switch between versions.
Install `locize-cli` globally using `npm install -g locize-cli`. Verify your npm global bin directory is in your system's PATH.
Double-check your API Key and Project ID for typos. Ensure the API Key has sufficient permissions for the requested action (e.g., read, write, admin access).
`locize-cli` is a command-line interface tool meant for shell execution, not programmatic import. Use `npm install -g locize-cli` and run `locize [command]` in your terminal.
No dependency data recorded yet.