Консольний клієнт (CLI)

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

  • Автоматизуйте процес оновлення вихідних файлів в вашому проекті Crowdin
  • Завантажуйте переклади Crowdin і автоматично зберігайте в потрібне місце
  • Надсилайте всі ваші існуючі переклади на Crowdin за пару хвилин
  • Інтегрувати Crowdin з GIT, SVN, Mercurial і іншими системами.
Примітка: Якщо ви використовуєте старішу версію Crowdin CLI (2.0.31 або новішої), прочитайте CLI v2 для отримання повної інформації.

Crowdin-cli - крос-платформовий додаток. Ви можете використовувати його в терміналах Linux або MacOS X, а також в командному рядку операційних системах Windows. Також його open-source та вихідний код доступні за адресою GitHub.

Що нового

  • Багатопотокове завантаження вихідних файлів і файлів перекладу
  • Поліпшення UX: індикатори процесу, стан завантаження, смайли
  • Створення інтерактивного файлу конфігурації
  • Bash/Zsh команда завершення
  • Покращений екран довідки для команд
  • Поліпшена перевірка файлів конфігурації
  • Більше варіантів імпорту для команди upload
  • Більше варіантів експорту для команди download
  • На основі нового API RESTful Crowdin API v2
  • Виправлені помилки та інші вдосконалення

Системні вимоги

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

Якщо у вас не встановлена Java, завантажте її з веб-сайту Oracle {:target=”_blank”}.

Встановлення

Homebrew для MacOS

Щоб встановити CLI Crowdin за допомогою homebrew (менеджер пакетів для MacOS):

$ brew tap crowdin/crowdin
$ brew install crowdin@3

Windows

Завантажте та запустіть інсталятор для Windows.

Debian

Ми підписуємо всі наші пакети за допомогою ключа підпису Crowdin.

Завантажити та встановити відкритий ключ підпису:

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

Використовуючи наступну команду, створіть файл crowdin.list у каталозі /etc/apt/sources.list.d:

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

І ваше сховище готове до використання. Ви можете встановити пакет 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

Створіть в каталозі /etc/yum.repos.d файл з ім’ям crowdin.repo, що містить:

[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 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. Виконайте ./install-crowdin-cli.sh в терміналі з правами sudo, щоб додати команду crowdin в свій термінал

Встановлення на 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 init

Під час виклику Crowdin CLI в терміналі, ви повинні знаходитися в кореневому каталозі проекту. В іншому випадку, вам доведеться вказати шлях до файлу конфігурації параметром --config:

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

Запустіть crowdin help щоб отримати більш детальну інформацію про інші команди.

Приклад файлу конфігурації:

"project_id": "projectId"                     #відкрийте налаштування проекту та перейдіть до розділу API 
"api_token": "personal-access-token"          #відкрийте налаштування проекту та перейдіть до розділу API & SSO > Новий токен > Створити токен
"base_path": "/project-base-path"
"base_url": "https://crowdin.com"
"preserve_hierarchy": true

"files": [
  {
      "source": "/en/**/*.json",                                          #фільтр вихідних файлів
      "translation": "/%two_letters_code%/**/%original_file_name%"        #де зберігаються переклади
  }
]

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

Використання

Після створення файлу конфігурації ви будете готові приступити до використання 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

Використовуйте заповнювачі для заміни відповідних змінних.

Щоб відобразити список файлів, які будуть завантажені в Crowdin:

$ crowdin upload sources --dryrun

Щоб завантажити існуючі переклади в Crowdin (переклади будуть синхронізовані):

$ crowdin upload translations

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

$ crowdin upload --help

Завантаження перекладів

Щоб завантажити останні версії перекладів з Crowdin:

$ crowdin download

Щоб завантажити останні переклади для певної мови (коди мов):

$ 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}

Source Strings Management

There is a possibility to manage (add, edit, delete) source strings for the following file types: CSV, RESX, JSON, Android XML, iOS strings, PROPERTIES.

To show a list of source strings in the current project (use the --verbose option to see more information):

crowdin string list

To create a new source string (use -h option to see all possible command options):

crowdin string add

To delete source string:

crowdin string delete

To edit existing source string:

crowdin string edit

Translation and Proofreading Progress

You can check the translation and proofreading progress for a project using the following commands.

To show both translation and proofreading progress for a project:

crowdin status

To show translation progress for a project:

crowdin status translation

To show proofreading progress for a project:

crowdin status proofreading

Also, you can use the --verbose option to see more information.

Дивись також

Ця стаття була корисною?