@mediamonks/polyglot

Download translations from polyglot

Usage no npm install needed!

<script type="module">
  import mediamonksPolyglot from 'https://cdn.skypack.dev/@mediamonks/polyglot';
</script>

README

Polyglot

A CLI to help with your translations managed in Polyglot.

Installation

npm

npm install -g @mediamonks/polyglot

yarn

yarn global add @mediamonks/polyglot

Usage

Usage: polyglot [options]

Commands:
  polyglot configure  Configure the cli.
  polyglot download   Download translations.

Options:
      --help      Show help                                                                                    [boolean]
  -t, --token     Project token                                                                                 [string]
  -s, --split     Split each language to its own file                                          [boolean] [default: true]
  -d, --dest      Location where the translations should be stored                                              [string]
  -e, --env       The environment from which to download the translations                      [string] [default: "dev"]
  -b, --base-url  The base url from which to download the translations                          [string] [default: null]

Examples:
  polyglot configure -b polyglot.domain             The base url of polyglot
  polyglot download -t={token} -d=src/data/lang -s  Download translations

For more information about the parameters, please visit https://github.com/mediamonks/polyglot

First time usage

For first time usage it's advised to set the base url of polyglot:

polyglot configure -b={url}

Downloading translations

polyglot download -t {your token} -d src/data/locale -s -e dev

Automatically download when building

Inside your package.json add below line to scripts.

...
"prebuild": "polyglot download --token={your token} --dest=src/data/locale --split"

Debugging

DEBUG=1 polyglot download -t {your token} -d src/data/locale -s -e dev

This will print the following information when an error occurs:

CWD: {{ current working directoy }}
USER HOME: {{ user home }}
CLI HOME: {{ cli home }}
DOWNLOAD URL: {{ the full download url }}
CONFIG: {
    "url": "{{ url }}"
}

To-Do

  • Managing a project from the CLI.
    • Create
    • Delete