Lingu Translate CLI

By Christoph Pageler
Lingu Translate

Lingu Translate comes with a command line interface that helps you to speed up your workflow. At this moment you can use Lingu CLI to import your localization files to lingu and to export translations from lingu to your localization files.

Prepare

When you downloaded the Lingu app from the AppStore, you also received the Lingu CLI. It is hidden in the directory of the Lingu App and therefore not very comfortable to reach. To change this you can create a symbolic link.

ln -s /Applications/Lingu.app/Contents/MacOS/LinguCLI /usr/local/bin/lingu

By doing this, you can access lingu from everywhere in your terminal.

Help

lingu --help shows you all the commands Lingu CLI provides.

lingu --help
OVERVIEW: A Lingu command line interface

With the Lingu command line interface you can automate your
localization tasks.

VERSION: 1.0.0

USAGE: lingu-cli <subcommand>

OPTIONS:
  --version               Show the version.
  -h, --help              Show help information.

SUBCOMMANDS:
  import                  Import localization files to a lingu document
  export                  Export a lingu document to your localization files

  See 'lingu-cli help <subcommand>' for detailed help.

Help for subcommands

By typing lingu help import or lingu import --help you get more informations about the subcommands.

lingu help import
OVERVIEW: Import localization files to a lingu document

USAGE: lingu-cli import [--config <config>] [--verbose] [--strict]

OPTIONS:
  --config <config>       File Path to your .lingu.yml 
        You can define the file path to your .lingu.yml file.
        If you don't provide any value, .lingu.yml file will be searched in the
        current working directory.
  --verbose               Enable verbose logging 
  --strict                Enable strict mode 
        When strict mode is enabled, lingu cli will not create any files which,
        but instead lingu cli will throw an error and stop execution.

        For example, the import command will not create a .lingu file if it does not yet exist.
        The export command will not create /your/path/{LOCALE} files if they do not exist yet.
  --version               Show the version.
  -h, --help              Show help information.

Lingu Configuration

As you can see in the help for the import command, lingu cli works with a configuration file. In the configuration file you can describe which files you want to import or export and in which lingu file you want to store everything.

For more information about the configuration file, see the more detailed help: