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 - seemles integration with GitHub Actions
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.9/install | bash
# Windows (PowerShell)
. { iwr -useb https://get.simplelocalize.io/2.9/install-windows } | iex;
# npm - https://github.com/simplelocalize/simplelocalize-cli-npm
npm install @simplelocalize/cliThe 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] ...parametersUpload command takes your local files and uploads them to SimpleLocalize.
simplelocalize upload
--apiKey PROJECT_API_KEY
--uploadPath INPUT_FILE
--uploadFormat FILE_FORMATGitHub Wiki: Upload 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_FORMATGitHub Wiki: Download translations
Auto-translate command starts auto-translation tasks for project languages and waits for the finish.
simplelocalize auto-translate --apiKey PROJECT_API_KEYGitHub Wiki: Auto-translate strings
There are two commands that operates on translation hosting resources which is publish and pull.
Publish translations between translation editor and hosting or between hosting environments.
simplelocalize publish
--apiKey PROJECT_API_KEY
--environment _latestPull command downloads files from translation hosting.
simplelocalize pull
--apiKey PROJECT_API_KEY
--pullPath ./hosting/
--environment _latestCommand creates a sample configuration file in the current directory.
simplelocalize initGitHub Wiki: Additional commands
Command gets project details and prints them.
simplelocalize status --apiKey PROJECT_API_KEYGitHub Wiki: Additional commands
Command removes all translations, translation keys and languages.
simplelocalize purge --apiKey PROJECT_API_KEYGitHub Wiki: Additional commands
Extract command finds translation keys and translations from the source code.
simplelocalize extract --searchDir SEARCH_DIRECTORY --projectType PROJECT_TYPE GitHub Wiki: Additional commands
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 uploadGitHub Wiki: Configuration file
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:[email protected]:8080Please 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)
See LICENSE for more details.
![@dependabot[bot]](https://avatars.githubusercontent.com/in/29110?s=64&v=4){kind=small}
