Console Client (CLI)

Crowdin CLI - это консольное приложение для интеграции вашего проекта с Crowdin, позволяющее автоматизировать управление и синхронизацию ресурсных файлов и переводов:

• Автоматизируйте процесс обновления исходных файлов в вашем проекте Crowdin
• Скачивайте переводы Crowdin и автоматически сохраняйте в нужное место
• Отправляйте все ваши существующие переводы на Crowdin за пару минут
• Integrate Crowdin with GIT, SVN, Mercurial, and more.

Crowdin-cli - кросс-платформенное приложение. Вы можете использовать его в терминалах Linux или MacOS X, а также в командной строке операционных системах Windows. It’s also open-source and it’s source code available at GitHub.

Системные требования

Убедитесь, что у вас установлена Java 8 или новее. Для проверки версии Java введите команду ` java -version ` в терминале (командная строка в Windows). Например, версия Java “1.8.0_212” означает, что у вас установлена Java 8 обновление 212.

Если у вас не установлена Java, загрузите ее с веб-сайта Oracle {:target=”_blank”}.

Установка

Homebrew для MacOS

To install the Crowdin CLI with homebrew (the package manager for macOS):

$ brew tap crowdin/crowdin

$ brew install crowdin@3

Windows

Download and run installer for Windows.

Debian

Мы подписываем все наши пакеты с помощью ключа подписи Crowdin.

Скачать и установить открытый ключ подписи:

wget -qO - https://artifacts.crowdin.com/repo/GPG-KEY-crowdin | sudo apt-key add -

Using the following command, create the crowdin.list file in the /etc/apt/sources.list.d directory:

echo "deb https://artifacts.crowdin.com/repo/deb/ /" > /etc/apt/sources.list.d/crowdin.list

And your repository is ready for use. Вы можете установить пакет Crowdin CLI Debian командой:

sudo apt-get update && sudo apt-get install crowdin3

Чтобы установить Crowdin CLI вручную:

$ wget https://artifacts.crowdin.com/repo/deb/crowdin3.deb -O crowdin.deb $ sudo dpkg -i crowdin.deb

RPM

Мы подписываем все наши пакеты с помощью ключа подписи Crowdin.

Скачать и установить открытый ключ подписи:

rpm --import https://artifacts.crowdin.com/repo/GPG-KEY-crowdin

Установка из репозитория RPM

Create a file called crowdin.repo in the /etc/yum.repos.d directory containing:

[crowdin] name=Crowdin repository baseurl=https://artifacts.crowdin.com/repo/rpm gpgcheck=1 gpgkey=https://artifacts.crowdin.com/repo/GPG-KEY-crowdin enabled=1

And your repository is ready for use. You can now install Crowdin CLI with one of the following commands:

sudo yum install crowdin3 sudo dnf install crowdin3

Чтобы установить Crowdin CLI вручную:

$ wget https://artifacts.crowdin.com/repo/rpm/crowdin3.rpm -O crowdin.rpm $ sudo rpm -U crowdin3.rpm

Автономная версия

Crowdin-cli можно установить как отдельное Java-приложение.

Установка на Linux и MacOS

1. Скачайте crowdin-cli.zip используя кнопку выше
2. Распакуйте его
3. Run ./install-crowdin-cli.sh in the terminal with sudo rights in order to add crowdin command to your terminal

Установка на Windows

1. Скачайте crowdin-cli.zip используя кнопку выше
2. Извлеките его содержимое в место, где вы хотите хранить Crowdin CLI
3. Откройте командную строку от имени Администратора
1. Нажмите Пуск
2. In the Start Search box, type cmd, and then press Ctrl+Shift+Enter
3. Если появится диалоговое окно Контроль учетных записей, убедитесь, что отображаемое действие соответствует желаемому, и нажмите Продолжить.
4. Запустите скрипт setup-crowdin.bat для добавления команды crowdin в командную строку
5. Перезапустите Командную строку

Запуск приложения

Используйте следующую команду для запуска приложения:

$ crowdin

Альтернативный метод:

$ java -jar crowdin-cli.jar

Файл конфигурации

To use Crowdin CLI you need to have a configuration file. We recommend to name it crowdin.yaml. You can create it running the command:

$ crowdin init

When calling Crowdin CLI in terminal you should be in your project root directory. Otherwise, you will have to specify a configuration file path using the --config option:

$ crowdin upload sources --config /path/to/your/config/file

Запустите crowdin help чтобы получить более подробную информацию о других командах.

Пример файла конфигурации:

"project_id": "projectId"                     #open project settings and go to API section 
"api_token": "personal-access-token"          #open profile settings and go to API & SSO > New Token > create Token
"base_path": "/project-base-path"
"base_url": "https://crowdin.com"
"preserve_hierarchy": true

"files": [
  {
      "source": "/en/**/*.json",                                          #source files filter
      "translation": "/%two_letters_code%/**/%original_file_name%"        #where translations are stored
  }
]

For more information on how to configure Crowdin CLI, read the Configuration File article.

Использование

После создания файла конфигурации вы будете готовы приступить к использованию crowdin cli для управления ресурсами локализации, а также сможете автоматизировать синхронизацию ваших файлов.

Общие команды

Для вывода на экран справочной информации:

$ crowdin help

Чтобы создать шаблон файла конфигурации:

$ crowdin init

Чтобы проверить файл конфигурации на наличие общих ошибок:

$ crowdin lint

Чтобы отобразить список загруженных в Crowdin файлов:

$ crowdin list project

Загрузка ресурсов

Чтобы загрузить исходные файлы в Crowdin:

$ crowdin upload sources

Чтобы загрузить один файл без конфигурации:

$ crowdin upload sources -s path/to/your/file -t file/export/pattern -T personal-token -i project-id --base-url https://crowdin.com

Use placeholders to put appropriate variables.

Чтобы отобразить список файлов, которые будут загружены в Crowdin:

$ crowdin upload sources --dryrun

Чтобы загрузить существующие переводы в Crowdin (переводы будут синхронизированы):

$ crowdin upload translations

Чтобы показать подробную информацию о команде upload:

$ crowdin upload --help

Скачивание переводов

Чтобы загрузить последние версии переводов из Crowdin:

$ crowdin download

To download latest translations for the specific language (language codes):

$ crowdin download -l {language_code}

Чтобы отобразить список последних переводов из Crowdin:

$ crowdin download --dryrun

Чтобы показать подробную информацию о команде download:

$ crowdin download --help

Управление версиями

There is no need to run a specific command to create version branches if synchronization tool is used. The version branch will be created automatically during the files upload.

Чтобы загрузить исходные файлы в указанную версию ветки:

$ crowdin upload sources -b {branch_name}

Чтобы загрузить переводы в указанную версию ветки:

$ crowdin upload translations -b {branch_name}

Чтобы скачать переводы из указанной версии ветки:

$ crowdin download -b {branch_name}

Полезная информация

• Файл конфигурации