Crowdin CLI uses a YAML configuration file that contains a description of the resources to manage: files to be uploaded into Crowdin and the locations of the corresponding translations.
To use Crowdin CLI, you should first generate your configuration file and then run the tool. By default, Crowdin CLI looks for a configuration file named crowdin.yaml (so you don’t have to specify the file name unless it’s different from crowdin.yaml).
To create the configuration file run the following command:
$ crowdin generateA valid Crowdin CLI YAML configuration file has the following structure, so please make sure that you fill out all the needed information:
See API Integration Setup article to learn where to find your project credentials.
A typical YAML configuration file looks similar to the following:
"project_identifier": "your-project-identifier" "api_key": "54e01e81--your-api-key--f6a2724a" #can be found in your project settings > API tab "base_path": "/home/office/source-code"
"files": [
{
"source" : "/resources/en/*.json", #source files filter
"translation" : "/resources/%two_letters_code%/%original_file_name%" #where translations are stored
}
]Note: On Windows, if you use Windows-style directory separator, it should be doubled according to the YAML syntax:
{
"source" : "\\resources\\en\\*.json",
"translation" : "\\resources\\%two_letters_code%\\%original_file_name%"
}To run the above configuration file and upload source files to Crowdin:
$ crowdin upload sourcesGet translations from Crowdin and put them to the right places:
$ crowdin downloadYou could load the API Credentials from an environment variable, for example:
"api_key_env": CROWDIN_API_KEY "project_identifier_env": CROWDIN_PROJECT_ID "base_path_env": CROWDIN_BASE_PATHIf mixed, api_key and project_identifier are prioritized:
"api_key_env": CROWDIN_API_KEY # Niedrige Priorität "project_identifier_env": CROWDIN_PROJECT # Niedrige Priorität "base_path_env": CROWDIN_BASE_PATH # Niedrige Priorität "api_key": "xxx" # Hohe Priorität "project_identifier": "yyy" # Hohe Priorität "base_path": "zzz" # Hohe PrioritätThe crowdin.yaml file contains a description of the resources to manage and API credentials (api_key, project_identifier, base_path). This means that it is unsafe to commit this file into the code repository because the API key would be accessible to other users. Crowdin CLI supports 2 types of configuration files:
Note: API credentials from .crowdin.yaml configuration file are of higher priority than credentials from project directory(crowdin.yaml).
If you need to run a command with user-specific credentials (for example upload sources) then run the following command:
$ crowdin upload sources --identity 'path-to-user-credentials-file'But if user-specific credentials file residing in $HOME/.crowdin.yaml you can simply run:
$ crowdin upload sourcesThe sample configuration provided above has source and translation attributes containing standard wildcards (also known as globbing patterns) to make it easier to work with multiple files.
Here are patterns you can use:
* (asterisk)
Represents any character in file or directory name. If you specify a “*.json” it will include all files like “messages.json”, “about_us.json” and anything that ends with “.json”.
** (doubled asterisk)
Matches any string recursively (including sub-directories). Note that you can use ** in both source and translation patterns. When using ** in the translation pattern, it will always contain sub-path from source for a certain file. For example, you can use source: ‘/en/**/*.po’ to upload all *.po files to Crowdin recursively. The translation pattern will be ‘/%two_letters_code%/**/%original_file_name%’.
? (question mark)
Matches any single character.
[set]
Matches any single character in a set. Behaves exactly like character sets in Regexp, including set negation ([^a-z]).
\ (backslash)
Escapes the next metacharacter.
Crowdin CLI allows to use the following placeholders to put appropriate variables into the resulting file name:
| Name | Beschreibung |
|---|---|
| %language% | Name der Sprache (z.B. Deutsch) |
| %two_letters_code% | Sprachcode ISO 639-1 (z.B. de) |
| %three_letters_code% | Sprachcode ISO 639-2/T (z.B. deu) |
| %locale% | Standort (z.B. de-DE) |
| %locale_with_underscore% | Standort (z.B. de_DE) |
| %original_file_name% | Ursprünglicher Dateiname |
| %android_code% | Android-Standort-ID für die Benennung von „values-“-Ordnern |
| %osx_code% | OS-X-Standort-ID für die Benennung von „lproj“-Ordnern |
| %original_path% | Verwendet die Namen der übergeordneten Ordner in Ihrem Projekt, um den Dateipfad im späteren Archiv zu bilden |
| %file_extension% | Ursprüngliche Dateierweiterung |
| %file_name% | Dateiname ohne Erweiterung |
You can also define the path for files in the resulting archive by putting a slash (/) at the beginning of the pattern.
Your translation option may look like: “/locale/%two_letters_code%/LC_MESSAGES/%original_file_name%”.
Structure of files and directories on the local machine:
- base_path | |-- folder | | | |-- 1.xml | |-- 1.txt | |-- 123.txt | |-- 123_test.txt | |-- a.txt | |-- a1.txt | |-- crowdin?test.txt | |-- crowdin_test.txt | |-- 1.xml |-- 1.txt |-- 123.txt |-- 123_test.txt |-- a.txt |-- a1.txt |-- crowdin?test.txt |-- crowdin_test.txt |-- 3.txt
Example 1. Usage of wildcards in the source path:
# ........your project configuration........
"files" : [
{ "source" : "/**/?[0-9].txt", #upload a1.txt, folder/a1.txt "translation" : "/**/%two_letters_code%_%original_file_name%" },
{ "source" : "/**/*\\?*.txt", #upload crowdin?test.txt, folder/crowdin?test.txt "translation" : "/**/%two_letters_code%*%original_file_name%" },
{ "source" : "/**/[^0-2].txt", #upload 3.txt, folder/3.txt, a.txt, folder/a.txt (ignore 1.txt, folder/1.txt) "translation" : "/**/%two_letters_code%_%original_file_name%" } ]Example 2. Usage of wildcards for ignoring files:
# ........your project configuration........
"files": [
{ "source" : "/**/*.*", #upload all files that the base_path contains "translation" : "/**/%two_letters_code%_%original_file_name%", "ignore" : [ "/**/%two_letters_code%_%original_file_name%", #ignore the translated files "/**/?.txt", #ignore 1.txt, a.txt, folder/1.txt, folder/a.txt "/**/[0-9].txt", #ignore 1.txt, folder/1.txt "/**/*\\?*.txt", #ignore crowdin?test.txt, folder/crowdin?test.txt "/**/\[0-9\]\[0-9\][0-9].txt", #ignore 123.txt , folder/123.txt "/**/[0-9]***.txt" #ignore 123_test.txt, folder/123_test.txt ] } ]Often software projects have custom names for locale directories. Crowdin allows you to map your own languages.
Let’s say your locale directories are named ‘en’, ‘uk’, ‘fr’, ‘de’. All of them can be represented by the %two_letters_code% placeholder. Still, you have one directory named ‘zh_CH’. In order to make it work with Crowdin CLI without changes in your project, you can add a languages_mapping section to your file set.
Mapping format is the following: “crowdin_language_code” : “code_you_use”. Check the full list of Crowdin language codes that can be used for mapping.
You can also override language codes for other placeholders like %android_code%, %locale%, etc.
You can set up Language Mapping for any of your project’s target languages via the user interface (UI):
If you need to rename a file with translations after the export, you can easily do this with the help of the parameter translation_replace.
For example, if the file is named “strings_en.xml” it can be renamed to “strings.xml”. For this, add a new parameter (at the same level as the translation parameter) to the configuration file (crowdin.yaml):
"files" : [
{ "source" : "/locale/**/en_*.po", "translation" : "/locale/**/%two_letters_code%_%original_file_name%", "translation_replace": { "en_" : "" } } ]In this case, “_en” will simply be erased from the file name.
From time to time there are files and directories you don’t need to translate in Crowdin. In such cases, local per-file rules can be added to the config file in your project.
"files": [
{ "source" : "/**/*.properties", "translation" : "/**/%file_name%_%two_letters_code%.%file_extension%", "ignore" : [ "/test/file.properties", "/example.properties" ] },
{ "source" : "/locale/en/**/*.po", "translation" : "/locale/%two_letters_code%/**/%original_file_name%", "ignore" : [ "/locale/en/templates", "/locale/en/workflow" ] } ]If a CSV file contains the translations for all target languages, you should specify appropriate language codes in the scheme.
CSV file example:
identifier,source_phrase,context,Ukrainian,Russian,French ID1,Quelle 1,Kontext 1,,, ID2,Quelle 2,Kontext 2,,, ID3,Quelle 3,Kontext 3,,,Configuration file example:
"files" : [
{
"source" : "multicolumn.csv",
"translation" : "multicolumn.csv",
"first_line_contains_header" : true,
"scheme" : "identifier,source_phrase,context,uk,ru,fr"
}
]If your CSV file contains columns that should be skipped on import, use none for such columns in the scheme, for example:
"scheme" : "identifier,source_phrase,context,uk,none,ru,none,fr""preserve_hierarchy": trueExample of file configuration using the preserve_hierarchy option:
"project_identifier": "test" "api_key": "KeepTheAPIkeySecret" "base_url": "https://api.crowdin.com" "base_path": "/path/to/your/project" "preserve_hierarchy": true
"files" : [
{ "source" : "/locale/en/**/*.po", "translation" : "/locale/%two_letters_code%/**/%original_file_name%" } ]By default, directories that do not contain any files for translation will not be created in Crowdin. For example:
- locale | |-- en | |-- foo.po |-- bar.po
By default, project files will be represented in Crowdin as following:
- foo.po
- bar.po
Using the option preserve_hierarchy, file structure in Crowdin will be the following:
- en | |-- foo.po |-- bar.po
This feature adds support for 2 optional parameters in the yaml file section: dest and type. This is typically used for projects, where the uploaded name must be different, so Crowdin can detect the type correctly. The dest parameter allows you to specify a file name in Crowdin.
dest parameter only works for single files, and if you use it, the configuration file should also include the preserve_hierarchy parameter with true value.Example of the configuration file with both parameters:
"project_identifier": "your-project-identifier" "api_key": "54e01e81--your-api-key--f6a2724a" #can be found in your project settings > API tab "base_path": "/home/office/source-code" "preserve_hierarchy": true
"files" : [
{ "source" : "/conf/messages", "dest" : "/messages.properties", "translation" : "/conf/messages.%two_letters_code%", "type" : "properties" },
{
"source" : "/app/strings.xml",
"dest" : "/strings.xml",
"translation" : "/res/values-%android_code%/%original_file_name%"
}
]The parameter update_option is optional. If it is not set, translations for changed strings will be lost. Useful for typo fixes and minor changes in source strings.
Depending on the value, update_option is used to preserve translations and preserve/remove validations of changed strings during file update.
The values are:
Example of the configuration file with update_option parameter:
"project_identifier": "your-project-identifier" "api_key": "54e01e81--your-api-key--f6a2724a" #can be found in your project settings > API tab "base_path": "/home/office/source-code"
"files" : [
{ "source" : "/*.csv", "translation" : "/%three_letters_code%/%file_name%.csv", "first_line_contains_header" : true, "scheme" : "identifier,source_phrase,translation,context", "update_option" : "update_as_unapproved" },
{
"source": "/**/*.xlsx",
"translation" : "/%three_letters_code%/folder/%file_name%.xlsx",
"update_option" : "update_without_changes"
}
]The command upload translations uploads existing translations to Crowdin. If no options specified, uploaded translations will not be imported even if they are duplicated or if they are equal with the source strings, and will not be approved.
The values are:
| translate_content optional | Bool. | Defines whether to translate texts placed inside the tags. Zulässige Werte sind: „0” und „1”. Der Standardwert ist 1. |
| translate_attributes optional | Bool. | Defines whether to translate tags' attributes. Zulässige Werte sind: „0” und „1”. Der Standardwert ist 1. |
| content_segmentation optional | Bool. | Defines whether to split long texts into smaller text segments. Zulässige Werte sind: „0” und „1”. Der Standardwert ist 1. Important! This option disables the possibility to upload existing translations for XML files when enabled. |
| translatable_elements optional | Array | This is an array of strings, where each item is the XPaths to DOM element that should be imported. Sample path: /path/to/node or /path/to/attribute[@attr] Note! If defined, the parameters translate_content and translate_attributes are not taken into account while importing. |
Example of the configuration file with additional parameters:
"project_identifier": "your-project-identifier" "api_key": "54e01e81--your-api-key--f6a2724a" #can be found in your project settings > API tab "base_path": "/home/office/source-code"
"files" : [
{ "source" : "/app/sample1.xml", "translation" : "/app/%locale%/%original_file_name%", "translate_attributes" : 1, "translate_content" : 0 },
{
"source" : "/app/sample2.xml",
"translation" : "/app/%locale%/%original_file_name%",
"translatable_elements" : [
"/content/text", # translatable texts are stored in "text" nodes of parent node "content"
"/content/text[@value]" # translatable texts are stored in "value" attribute of "text" nodes
]
}
]Defines whether a single quote should be escaped by another single quote or backslash in exported translations. You can add escape_quotes per-file option. Zulässige Werte sind: „0”, „1”, „2” und „3”. Der Standardwert ist 3.
The values are:
Escape special characters
Defines whether any special characters (=, :, ! and #) should be escaped by backslash in exported translations. You can add escape_special_characters per-file option.
Acceptable values are: 0, 1. Der Standardwert ist 1.
Example of the configuration file:
"project_identifier": "your-project-identifier" "api_key": "54e01e81--your-api-key--f6a2724a" #can be found in your project settings > API tab "base_path": "/home/office/source-code"
"files" : [
{
"source" : "/en/strings.properties",
"translation" : "/%two_letters_code%/%original_file_name%",
"escape_quotes" : 1,
"escape_special_characters" : 0
}
]"project_identifier": "test" "api_key": "KeepTheAPIkeySecret" "base_url": "https://api.crowdin.com" "base_path": "/path/to/your/project"
"files" : [
{
"source" : "/*.csv",
"translation" : "/%two_letters_code%/%original_file_name%",
# Defines whether first line should be imported or it contains columns headers
"first_line_contains_header" : true,
# Used only when uploading CSV file to define data columns mapping.
"scheme" : "identifier,source_phrase,translation,context,max_length"
}
]"project_identifier": "your-project-identifier" "api_key": "54e01e81--your-api-key--f6a2724a" #can be found in your project settings > API tab "base_path": "/home/website"
"files" : [
{
"source" : "/locale/en/**/*.po",
"translation" : "/locale/%two_letters_code%/LC_MESSAGES/%original_file_name%",
"languages_mapping" : {
"two_letters_code" : {
"zh-CN" : "zh_CH",
"fr-QC": "fr"
}
} } ]"project_identifier": "your-project-identifier" "api_key": "54e01e81--your-api-key--f6a2724a" #can be found in your project settings > API tab "base_path": "/home/android-app"
"files" : [
{
"source" : "/res/values/*.xml",
"translation" : "/res/values-%android_code%/%original_file_name%",
"languages_mapping" : {
"android_code" : {
"de" : "de",
"ru" : "ru"
}
} } ]VCS integrations require the same configuration file as the CLI tool, meaning the same structure is supported. The only difference, is that the project credentials should not be stored in the file header for security reasons. Also, two additional parameters can be used.
Each time translations are commited the default message is shown “New translations {fileName} ({languageName})”. You can use commit_message parameter to add Git tags, in order to skip builds, add tests, and more.
Beispiel:
"base_path": "/home/office/source-code" "commit_message": "[ci skip]" "files": [
{
"source" : "/resources/en/*.json", #source files filter
"translation" : "/resources/%two_letters_code%/%original_file_name%" #where translations are stored
}
]To replace the default commit message, use append_commit_message parameter with the value false. You can also add two optional placeholders: %original_file_name% and %language% to use the appropriate file name and language variables accordingly.
Beispiel:
"commit_message": "Fix: New translations %original_file_name% from Crowdin" "append_commit_message": false "files": [
{
"source" : "/resources/en/*.json", #source files filter
"translation" : "/resources/%two_letters_code%/%original_file_name%" #where translations are stored
}
]By default, all the languages are exported. If you need to export some specific languages, use export_languages paramenter to specify them.
Beispiel:
"base_path": "/home/office/source-code" "export_languages": [ "ru", "uk", "ja" ] "files": [
{
"source" : "/resources/en/*.json", #source files filter
"translation" : "/resources/%two_letters_code%/%original_file_name%" #where translations are stored
}
]Need help working with Crowdin CLI or have any questions? Contact Support Team.