Skip to content
Jakub edited this page Aug 11, 2025 · 21 revisions

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.10/install | bash

# Windows (PowerShell)
. { iwr -useb https://get.simplelocalize.io/2.10/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 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
  • purge - removes all translation, translation keys and languages from the project
  • extract - finds and extracts translation keys in your project files

Translation Hosting commands:

  • pull - downloads translation files from translation hosting
  • publish - publishes translations to translation hosting environment

SimpleLocalize CLI

📦 Getting Started

Links


Clone this wiki locally