Home

SimpleLocalize CLI is a command-line tool that allows you to manage translations in your software project, and it's a great tool for CI/CD pipelines and localization automation.

• Upload and download translations - synchronise translation between your source code and Translation Editor.
• Auto-translate strings - Start auto-translation jobs from the command-line and get translated strings in a few minutes.
• Host translations - Push and pull translations from Translation Hosting to your project using the command-line.
• GitHub Actions support - Use SimpleLocalize CLI in your GitHub Actions workflows.
• Check project status - Get project details from the command-line and check if your translations are up-to-date.

Installation

The installation process is automated by command-line scripts. Both scripts for Windows (PowerShell) and macOS/Linux/Windows downloads a binary file with CLI, copies it to user files and makes it available to run anywhere in the system from a command-line.

# macOs / Linux / Windows (WSL)
curl -s https://get.simplelocalize.io/2.8/install | bash

# Windows (PowerShell)
. { iwr -useb https://get.simplelocalize.io/2.8/install-windows } | iex;

To change or update the CLI version, run the installation script with the desired version number in the URL, e.g.:

• https://get.simplelocalize.io/2.0.6/install installs version 2.0.6 on macOS/Linux/Windows (WSL)
• https://get.simplelocalize.io/2.0.6/install-windows installs version 2.0.6 on Windows (PowerShell)

See releases for the list of available versions.

Usage

The command-line tool offers several commands to execute. All of them requires Project API Key that is unique for each project. You can set apiKey in simplelocalize.yml configuration file, pass it as parameter with --apiKey or set it by environment variable SIMPLELOCALIZE_API_KEY.

simplelocalize [command] ...parameters

Available commands:

• init - creates a sample configuration file
• status - gets translation project details
• upload - uploads translation files or translation keys
• download - downloads translation files
• auto-translate - starts auto-translation jobs
• pull - downloads translation files from Translation Hosting
• publish - publishes translations to Translation Hosting
• purge - removes all translation, translation keys and languages from the project
• extract - finds and extracts translation keys in your project files

Configuration file

Command creates a sample configuration file in the current directory. The configuration file simplifies the usage of the command-line tool by providing a default configuration for the project and allowing to omit some parameters.

simplelocalize init

# Get started with CLI: https://simplelocalize.io/docs/cli/get-started/
# Available formats: https://simplelocalize.io/docs/general/file-formats/
# Available import/export options: https://simplelocalize.io/docs/general/options/
# Support: [email protected]

# Project API Key
apiKey: API_KEY

# Properties used by the 'upload' command
uploadPath: ./source-translations/messages_en.json
uploadLanguageKey: en-GB
uploadFormat: single-language-json
uploadOptions:
  # by default, the 'upload' command only adds new keys and fills empty translations, 
  # add this option to overwrite existing translations with values from the uploaded file
  - REPLACE_TRANSLATION_IF_FOUND 

# Properties used by the 'download' command
downloadPath: ./output-translations/messages_{lang}.json
downloadLanguageKeys: ['de-DE', 'fr-FR', 'pl-PL']
downloadFormat: single-language-json
downloadOptions:
  - WRITE_NESTED

# Properties used by 'pull' and 'publish' command    
pullPath: ./src/hosting/
environment: '_production' # or '_latest', or 'my_custom'