@crowdin/cli
Advanced tools
Crowdin CLI is a command line tool that allows you to manage and synchronize your localization resources with your Crowdin project
Crowdin CLI is a command line tool that allows you to manage and synchronize your localization resources with your Crowdin project. Using CLI, you can:
This is a cross-platform and it runs in a terminal on Linux based and macOS operating systems or in Command Prompt on Windows.
CLI v3 has a lot of updates and improvements:
upload commanddownload commandcontent_segmentation option support for xml, html, md, fm_md, fm_html, flsnp, docx, idml, ditaescape_special_characters option support for properties file--dryrun option for translations uploadignore pattern improvementsinit alias to generate commandNote: for CLI v2 see the branch.
Check if you have Java 8 or newer installed. Type java -version command in the terminal (Command Prompt on Windows) to check Java version.
For example, java version "1.8.0_212" means that you have Java 8 Update 212 installed.
brew tap crowdin/crowdin
brew install crowdin@3
Download and run installer for Windows.
We sign all our packages with the Crowdin Signing Key.
Download and install the public signing key:
wget -qO - https://artifacts.crowdin.com/repo/GPG-KEY-crowdin | sudo apt-key add -
Using the following command, create the crowdin.list file in the /etc/apt/sources.list.d directory:
echo "deb https://artifacts.crowdin.com/repo/deb/ /" > /etc/apt/sources.list.d/crowdin.list
And your repository is ready for use. You can install the Crowdin CLI Debian package with:
sudo apt-get update && sudo apt-get install crowdin3
To install the Crowdin CLI manually:
wget https://artifacts.crowdin.com/repo/deb/crowdin3.deb -O crowdin.deb
sudo dpkg -i crowdin.deb
We sign all our packages with the Crowdin Signing Key.
Download and install the public 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:
/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
And your repository is ready for use. You can now install Crowdin CLI with one of the following commands:
sudo yum install crowdin3
sudo dnf install crowdin3
To install the Crowdin CLI manually:
wget https://artifacts.crowdin.com/repo/rpm/crowdin3.rpm -O crowdin.rpm
sudo rpm -U crowdin3.rpm
Visit the Crowdin CLI package page on Arch Linux user repository.
Crowdin CLI can be installed as a stand-alone Java application.
Download for MacOS, Linux and Windows
./install-crowdin-cli.sh in the terminal with sudo rights in order to add crowdin command to your terminalcmd, and then press CTRL+SHIFT+ENTERsetup-crowdin.bat script in order to add crowdin command to the Command PromptUse the following method to run the app:
crowdin
Alternative method:
java -jar crowdin-cli.jar
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 or crowdin.yml (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 init
When calling Crowdin CLI in terminal make sure you are in your project root directory. Otherwise, you need to specify a configuration file path using --config option:
crowdin upload sources --config /path/to/your/config/file
Sample configuration file:
"project_id": "12"
"api_token": "54e01--your-personal-token--2724a"
"base_path": "."
"base_url": "https://api.crowdin.com" # https://{organization-name}.crowdin.com
"preserve_hierarchy": true
"files": [
{
"source" : "/t1/**/*",
"translation" : "/%two_letters_code%/%original_file_name%"
}
]
For more information how to configure Crowdin CLI, check Configuration File article.
Once the configuration file is created, you can use Crowdin CLI to manage your localization resources and automate file synchronization.
To display help information:
crowdin -h
crowdin <command> -h
To generate skeleton configuration file:
crowdin init
To check configuration file for general mistakes:
crowdin lint
To display a list of files uploaded to Crowdin:
crowdin list project
To upload source files to Crowdin:
crowdin upload sources
To upload single file without a configuration:
crowdin upload sources \
-s path/to/your/file \
-t file/export/pattern \
-T personal-access-token \
-i project-id \
--base-url https://api.crowdin.com
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 detailed information about the upload command:
crowdin upload --help
To download the latest translations from Crowdin:
crowdin download
To download the latest translations for the specific language (language codes):
crowdin download -l {language_code}
To display a list of the latest translations from Crowdin:
crowdin download --dryrun
To show detailed information about the download command:
crowdin download --help
There is no need to run specific command to create version branches if you use synchronization tool. The version branch is 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}
There is a possibility to manage (add, edit, delete) source strings for the following file types: CSV, RESX, JSON, Android XML, MACOSX, STRINGS, PROPERTIES.
| Command | Description |
|---|---|
crowdin string list | Show a list of source strings in the current project. You can use the --verbose option to see more information |
crowdin string add | Create a new source string. Use -h option to see all possible command options |
crowdin string delete | Delete source string |
crowdin string edit | Edit existing source string |
To show translation and proofreading progress for a project use the following commands:
| Command | Description |
|---|---|
crowdin status | Show translation and proofreading progress for a project |
crowdin status translation | Show only translation progress for a project |
crowdin status proofreading | Show only proofreading progress for a project |
Also, you can use the --verbose option to see more information.
If you find any problems or would like to suggest a feature, please read the How can I contribute section in our contributing guidelines.
Need help working with Crowdin CLI or have any questions? Contact Customer Success Service.
If you want to contribute please read the Contributing guidelines.
The Crowdin CLI is licensed under the MIT License. See the LICENSE.md file distributed with this work for additional information regarding copyright ownership. Except as contained in the LICENSE file, the name(s) of the above copyright holders shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization.
[3.2.2] - 2020-09-01
FAQs
Crowdin CLI is a command line tool that allows you to manage and synchronize your localization resources with your Crowdin project
The npm package @crowdin/cli receives a total of 28,839 weekly downloads. As such, @crowdin/cli popularity was classified as popular.
We found that @crowdin/cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."