SimpleLocalize CLI

Translation Management for software projects

The easiest way to manage translation files for web and mobile apps.

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.

• Synchronize files - keep in sync all your translation files
• Auto-translate - auto-translate texts in seconds
• Host translations - manage your hosted translations
• GitHub Actions support - seamless integration with GitHub Actions

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. The CLI supports macOS (both Apple Silicon and Intel), Linux (x86 and ARM64), and Windows.

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

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

# npm - https://github.com/simplelocalize/simplelocalize-cli-npm
npm install @simplelocalize/cli

GitHub Wiki: Installation

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 via configuration file, pass it as parameter with --apiKey or by environment variable SIMPLELOCALIZE_API_KEY.

simplelocalize [command] ...parameters

GitHub Wiki: Usage

Upload translations

Upload command takes your local files and uploads them to SimpleLocalize.

simplelocalize upload 
  --apiKey PROJECT_API_KEY
  --uploadPath INPUT_FILE
  --uploadFormat FILE_FORMAT
  --uploadLanguageKey en

GitHub Wiki: Upload translations

Download translations

Download command takes translations from SimpleLocalize and saves them to your local files.

simplelocalize download 
  --apiKey PROJECT_API_KEY
  --downloadPath DOWNLOAD_PATH
  --downloadFormat FILE_FORMAT
  --downloadLanguageKey en,de,fr

GitHub Wiki: Download translations

Auto-translate strings

Auto-translate command starts auto-translation tasks for project languages and waits for the finish.

simplelocalize auto-translate --apiKey PROJECT_API_KEY

GitHub Wiki: Auto-translate strings

Translation Hosting

There are two commands that operates on translation hosting resources which is publish and pull.

Publish translations

Publish translations between translation editor and hosting or between hosting environments.

simplelocalize publish
  --apiKey PROJECT_API_KEY
  --environment _latest

GitHub Wiki: Pull resources

Pull resources

Pull command downloads files from translation hosting.

simplelocalize pull
  --apiKey PROJECT_API_KEY
  --pullPath ./hosting/
  --environment _latest

GitHub Wiki: Pull resources

Additional commands

Initalize configuration file

Command creates a sample configuration file in the current directory.

simplelocalize init

GitHub Wiki: Additional commands

Get project details

Command gets project details and prints them.

simplelocalize status --apiKey PROJECT_API_KEY

GitHub Wiki: Additional commands

Purge translations

Command removes all translations, translation keys and languages.

simplelocalize purge --apiKey PROJECT_API_KEY

GitHub Wiki: Additional commands

Extract translation keys

Extract command finds translation keys and translations from the source code.

simplelocalize extract --searchDir SEARCH_DIRECTORY --projectType PROJECT_TYPE 

GitHub Wiki: Additional commands

Configuration file

Create configuration file to to simplify the bash commands. Arguments used in command always override properties set in the configuration file.

# It load simplelocalize.yml file by default
simplelocalize upload

GitHub Wiki: Configuration file

Language mapping (2.11+)

Mapping between SimpleLocalize language key and {lang} placeholder. On download the SimpleLocalize language key is mapped to the {lang} placeholder, On upload the {lang} placeholder is mapped back to the SimpleLocalize language key. This can be used to customize where files are downloaded, e.g., to download 'en' to '/values/' instead of '/values-en/'.

downloadPath: ./res/values{lang}/strings.xml
downloadFormat: android-strings
mappings:
  lang:
    - languageKey: "en"
      placeholder: ""      # download 'en' to ./res/values/strings.xml
    - languageKey: "de"
      placeholder: "-de"   # download 'de' to ./res/values-de/strings.xml

Proxy support

SimpleLocalize CLI supports HTTP and HTTPS proxies, and it respects the http_proxy, https_proxy environment variables.

Here are some examples of how to set proxy environment variables in Linux and macOS:

export http_proxy=http://someproxy.com
export http_proxy=http://someproxy.com:8080
export http_proxy=http://user:password@someproxy.com:8080

GitHub Wiki: Proxy support

Support

Please refer to the official SimpleLocalize documentation. That should help you troubleshoot common issues. For additional help, you can reach out to us on one of these channels:

• GitHub (Bug and issue reports)
• Email (General support)
• Changelog (Product updates)
• YouTube (How-to tutorials)

License

See LICENSE for more details.