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

Crowdin CLI is a command line tool that allows you to manage and synchronize your localization resources with your Crowdin project:

• Automate the process of updating your source files in your Crowdin project
• Download translations from Crowdin and automatically save them in the correct locations
• Upload all your existing translations to Crowdin in minutes
• Integrate Crowdin with GIT, SVN, Mercurial and more…

This is a cross-platform and it runs in a terminal on Linux based and macOS operating systems or in Command Prompt on Windows. It’s also open-source and it’s source code available at GitHub.

Requirements

Check that you have Java 7 or newer installed. Type java -version command in the terminal (Command Prompt on Windows) to check Java version. For example, java version “1.7.0_55” means that you have Java 7 Update 55 installed.

If you don’t have Java installed, download it from Oracle’s website.

Установка

Homebrew for macOS

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

$ brew install crowdin

Windows

Download and run installer for Windows

Debian

We sign all our packages with the Crowdin Signing Key.

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

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

Save the repository definition to /etc/apt/sources.list.d/crowdin.list:

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

You can install the Crowdin CLI Debian package with:

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

To install the Crowdin CLI manually:

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

RPM

We sign all our packages with the Crowdin Signing Key.

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

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

Installing from the RPM repository

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 crowdin
sudo dnf install crowdin

To install the Crowdin CLI manually:

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

Standalone Version

Crowdin CLI can be installed as a stand-alone Java application.

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

1. Download crowdin-cli.zip using the button above
2. Распакуйте его
3. Run . crowdin.sh in the terminal with sudo rights in order to add crowdin command to your terminal

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

1. Download crowdin-cli.zip using the button above
2. Extract it's content to the place where you want Crowdin CLI to be stored
3. Open Command Prompt as an Administrator
1. Click Start
2. In the Start Search box, type cmd, and then press CTRL+SHIFT+ENTER
3. If the User Account Control dialog box appears, confirm that the action it displays is what you want, and then click Continue
4. Run setup-crowdin.bat script in order to add crowdin command to the Command Promt
5. Restart your Command Promt

Running the App

Use the following method to run the app:

$ crowdin

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

$ java -jar crowdin-cli.jar

Configuration

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

Run crowdin help to get more details regarding other commands.

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

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

"preserve_hierarchy": true

"files": [
  {
    "source" : "/t1/**/*",
    "translation" : "/%two_letters_code%/%original_file_name%"
  }
]

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

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

Once the configuration file is created, you are ready to start using Crowdin CLI to manage your localization resources and automate file synchronization.

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

To display help information:

$ crowdin help

To generate a skeleton configuration file:

$ crowdin generate

To check configuration file for general mistakes:

$ crowdin lint

To display a list of uploaded files to Crowdin:

$ crowdin list project

Uploading Resources

To upload source files to Crowdin:

$ crowdin upload sources

To upload a single file without configuration:

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

Use placeholders to put appropriate variables.

To display a list of files that will be uploaded to Crowdin:

$ crowdin upload sources --dryrun

To upload existing translations to Crowdin (translations will be synchronized):

$ crowdin upload translations

To show a detailed information about the upload command:

$ crowdin upload --help

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

To download latest translations from Crowdin:

$ crowdin download

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

$ crowdin download -l {language_code}

To display a list of latest translations from Crowdin:

$ crowdin download --dryrun

To show a detailed information about the download command:

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

To upload source files to the specified version branch:

$ crowdin upload sources -b {branch_name}

To upload translations to the specified version branch:

$ crowdin upload translations -b {branch_name}

To download translations from the specified version branch:

$ crowdin download -b {branch_name}

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

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