CLI: Extract keys

Last modified: March 30, 2021Author:Β Jakub PomykaΕ‚a

Extract translation keys from your project files. Choose 'projectType' and invoke 'extract' command. The CLI will upload found translation keys to the translation editor. The CLI will process your local files for given path ('searchDir' parameter) and find all used translation keys. Every found translation key will be added to the translation editor.

extract translations

πŸ’Ώ Installation

Install SimpleLocalize CLI

curl -s https://get.simplelocalize.io/install | bash

Problems with CLI? See troubleshooting section.

πŸ‘¨β€πŸ’» Usage

simplelocalize extract \
  --apiKey PROJECT_API_KEY \
  --projectType yahoo/react-intl \
  --searchDir ./src

πŸ“– Supported libraries

Libraries from which you can extract translation keys

Library projectType value Ready?
react-intl yahoo/react-intl βœ…
Standard Android internationalization google/android βœ…
Standard iOS internationalization apple/ios-macos βœ…
react-i18next i18next/i18next βœ…
mde/ejs mde/ejs βœ…
ember-intl ember-intl/ember-intl [ ]
jekyll-multiple-languages-plugin Anthony-Gaudino/jekyll-multiple-languages-plugin [ ]
dust-intl yahoo/dust-intl [ ]
handlebars-intl yahoo/handlebars-intl [ ]

Do you already have extracted translation keys to file? Great! Use Localization CLI Tool to upload translations to the translation editor.

πŸ‘©β€πŸ« How message extraction works?

For example to translate frontend application in ReactJS you can use 3rd party library like yahoo/react-intl:

Example yahoo/react-intl usage in React app code:

<FormattedMessage id="LOGIN"/>

Translation key LOGIN will be found by localization CLI tool.

simplelocalize extract --apiKey API_KEY --projectType PROJECT_TYPE --searchDir ./src

CLI extraction

πŸŽ‰ Done! CLI will find i18n keys, and push them to translation editor.