Installation

Learn how to install Localazy CLI for Linux, Windows and macOS or as a Java app or Docker image.

Localazy CLI is available as a native app for all major platforms (Windows, Linux and macOS), Java’s JAR and Docker image.

For more information about using Localazy CLI please refer to basics and command-line options.

Java/JVM

For using the Java version of Localazy CLI, you need JRE/JDK 8 and above available on your machine.

Download:

Run CLI:

java -jar localazy.jar [command] [options] [groups]

Linux

Localazy CLI for Linux is a native app, and it only has single dependency on libcurl (for HTTPS communication).

Debian/Ubuntu

Add repository and install:

curl -sS https://dist.localazy.com/debian/pubkey.gpg | sudo apt-key add - 
echo "deb [arch=amd64] https://maven.localazy.com/repository/apt/ stable main" | sudo tee /etc/apt/sources.list.d/localazy.list

sudo apt-get update && sudo apt-get install localazy

Run CLI:

localazy [command] [options] [groups]

RHEL/CentOS

Download and install:

curl -sS https://dist.localazy.com/rhel/localazy.repo | tee /etc/yum.repos.d/localazy.repo

yum install localazy

Run CLI:

localazy [command] [options] [groups]

Manual installation

If the libcurl is not installed on your system, install it:

  • Debian/Ubuntu: apt install libcurl4
  • or use the standard package manager for your distribution

Download DEB:

Download RPM:

Download binary:

Run CLI:

localazy [command] [options] [groups]

Autocomplete for bash / zsh

You can generate and install the autocomplete script for your shell by invoking command:

# for bash
sudo mkdir -p /usr/share/bash-completion/completions && sudo bash -c '_LOCALAZY_COMPLETE=bash localazy > /usr/share/bash-completion/completions/localazy'

# for zsh
_LOCALAZY_COMPLETE=zsh localazy > ~/.localazy-autocomplete.sh && echo source ~/.localazy-autocomplete.sh >> ~/.zshrc

The bash autocomplete script is installed automatically when installed from repository, DEB or RPM.

macOS

Localazy CLI is available through brew; just use the command-line to install it:

> brew tap localazy/tools
> brew install localazy

Run CLI:

localazy [command] [options] [groups]

You can also download the binary directly. However, it depends on libcurl (can be installed with brew install curl).

Download direct binary:

Windows

Localazy CLI for Windows is a native app and has no depedencies.

Download:

Run CLI:

localazy.exe [command] [options] [groups]

Note: Whenever working with file paths in the Localazy configuration file, we strongly advise you to use POSIX / path separator instead of the backslash. It simplifies parsing and writing transformation rules.

Docker

The Localazy CLI is available on Docker repository as localazy/cli. It has no entrypoint and no cmd and the localazy command is supposed to be run manually as per your needs.

The container is based on ubuntu:18.04 so you can easily reuse it for more purposes.

The workdir inside the container is /localazy and you should mount your working directory to it using -v parameter.

Typical usage

docker run --rm -v $(pwd):/localazy localazy/cli:latest localazy [command] [options] [groups]

Details:

  • --rm - the container is removed automatically when the operation finishes
  • -v $(pwd):/localazy - mount the current directory as working directory
  • localazy/cli:latest - use the latest available Localazy CLI version
  • localazy [command] [options] [groups] - the actual invocation of Localazy CLI

Notes

The native version of Localazy CLI available for Windows, Linux and macOS requires 64-bit system.

If you are still running 32-bit system, please use Java version with appropriate 32-bit JRE/JDK.

Documentation:

File Formats: