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

Note: If you are using the old version of Crowdin CLI (0.5.5 or less) see Crowdin GitHub for full details.
Note: We also offer a new version of our CLI that is currently in beta status. To learn more, read the article CLI v3.

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.

Що нового

  • Новий тип YAML конфігурації
  • Перевірка файлу конфігурації за допомогою команди lint
  • Генерація файлу конфігурації за допомогою команди generate
  • Покращено процес завантаження файлів
  • Можливість працювати з одним файлом без конфігурації
  • Параметр --dryrun, щоб переглянути інші варіанти керованих файлів

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

Переконайтеся, що у вас встановлена 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. Ви можете встановити пакет Crowdin CLI Debian командою:

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

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

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. Перезапустіть Командний рядок

Запуск додатку

Використовуйте наступну команду для запуску додатка:

$ кравдін

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

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

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_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

Керування версіями

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}

Дивись також

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