Консольный клиент (CLI)

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

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

Crowdin-cli - кросс-платформенное приложение. Вы можете использовать его в терминалах Linux или MacOS X, а также в командной строке операционных системах Windows. Исходный код приложения можно найти в нашем проекте на GitHub.

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

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

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

Установка

Homebrew для MacOS

Чтобы установить CLI Crowdin с помощью homebrew (менеджер пакетов для MacOS):

$ brew install crowdin

Windows

Загрузите и запустите установщик для Windows

Debian

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

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

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

Create a file called crowdin.list in the /etc/apt/sources.list.d directory containing:

deb https://artifacts.crowdin.com/repo/deb/ /

And your repository is ready for use. You can install the Crowdin CLI Debian package with:

sudo apt-get update && sudo apt-get install crowdin

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

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

RPM

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

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

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

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

Создайте файл crowdin.repo в каталоге /etc/yum.repos.d, содержащий следующее:

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

И ваш репозиторий готов к использованию. Теперь вы можете установить Crowdin CLI с помощью одной из следующих команд:

sudo yum install crowdin
sudo dnf install crowdin

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

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

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

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

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

1. Скачайте crowdin-cli.zip используя кнопку выше
2. Распакуйте его
3. Run ./crowdin.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. В поле Начать поиск введите cmd и нажмите сочетание клавиш CTRL + SHIFT + ENTER
3. Если появится диалоговое окно Контроль учетных записей, убедитесь, что отображаемое действие соответствует желаемому, и нажмите Продолжить.
4. Запустите скрипт setup-crowdin.bat для добавления команды crowdin в командную строку
5. Перезапустите Командную строку

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

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

$ crowdin

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

$ java -jar crowdin-cli.jar

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

Чтобы использовать Crowdin CLI, вам нужен файл конфигурации. Мы рекомендуем назвать его crowdin.yaml, Вы можете создать его с помощью команды:

$ crowdin generate

Вызывая crowdin cli через терминал, вы должны находится в корневой папке вашего проекта. В противном случае, вам придется указать путь к файлу конфигурации с использованием опции --config:

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

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

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

"project_identifier" : "your-project-identifier"
"api_key" : "your-api-key"
"base_path" : "your-base-path"
"preserve_hierarchy": true

"files": [
  {
    "source" : "/en/**/*.json",
    "translation" : "/%two_letters_code%/**/%original_file_name%"
  }
]

Для получения дополнительной информации о том, как настроить Crowdin CLI, посмотрите статью файл конфигурации.

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

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

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

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

$ crowdin help

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

$ crowdin generate

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

$ crowdin lint

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

$ crowdin list project

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

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

$ crowdin upload sources

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

$ crowdin upload sources -s path/to/your/file -t file/export/pattern -k your-key -i your-identifier

Используйте заполнители чтобы подставить соответствующие переменные.

Чтобы отобразить список файлов, которые будут загружены в 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

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

Нет необходимости, запускать определённую команду, чтобы создать ветвь версии, если использовать инструмент синхронизации. Версии будут созданы автоматически во время загрузки файлов.

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

$ crowdin upload sources -b {branch_name}

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

$ crowdin upload translations -b {branch_name}

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

$ crowdin download -b {branch_name}

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

• Управление версиями
• [Файл конфигурации]