Skip to content

localeum/localeum-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Localeum CLI tool

Using the Localeum CLI, you can integrate the Localeum platform into your CI/CD process to download actual translations.

Read more docs on https://docs.localeum.com

Getting started

Install

MacOS

Install using Homebrew:

$ brew tap localeum/tools
$ brew install localeum-cli

Direct links:

Linux

Direct links:

FreeBSD

Direct links:

Windows

Direct links:

Configure

Initialization

Run the command in the root directory of your application.

$ localeum-cli init

Follow a few steps to create a config file.

Enter the API key for your project: 

Your API key can be found on the project settings page (https://app.localeum.com/projects/{YOUR_PROJECT}/settings)

Enter the path to the directory for the localization files:

The directory where the localization files will be saved, for example locales

Enter the file format for export (json, json_nested, csv, yaml): 

If you did everything correctly, you will see the inscription.

Success! You finished initializing your application!

The config file localeum.yml should appear at the root of your project.

Command: pull

To download the latest translations, run the following command.

$ localeum-cli pull

Configuration file options

Localeum CLI configuration files use the YAML.
The localeum.yml file must be in the root of the project.

Example:

api-key: "{your API key}"
directory: "locales"
format: "json"
Option Default Required
api-key null Yes
directory null Yes
format null Yes
filename-template %lang% No

Format

Possible variants: json, json_nested, arb, csv.

Filename template

This template to create your own filename.
Possible replaces:

%lang%

Language

Example: intl_%lang% => intl_en.{ext}

About

Using the Localeum CLI, you can integrate the Localeum platform into your CI/CD process to download actual translations.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published