Introduction
Welcome to the official documentation site for Crowdin CLI - a powerful command-line tool that simplifies the management of your localization projects on Crowdin. With Crowdin CLI, you can easily upload source files, download translations, and keep your localized content up-to-date with just a few simple commands.
So, whether you're looking to streamline your localization process, improve your team's collaboration, or simply save time and effort, Crowdin CLI is the tool for you.
- 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
This is a cross-platform, and it runs in a terminal on Linux based and macOS operating systems or in Command Prompt on Windows
Features
- Upload source files and existing translations to a Crowdin project
- Download the latest translations from Crowdin to the specified place
- Multithreading for source and translation files upload
- Show translation and proofreading progress for a project
- Manage source strings in a Crowdin project
- Manage glossaries and translation memories
- Manage tasks in a Crowdin project
- Manage source files and branches in the current project
- Run Pre-Translation
- Bash/Zsh command completion
- Process indicators, loading states, emojis
- HTTP Proxy support including authorization
- Interactive generation of a configuration file
- and more.
Usage
Here is an overview of the basics of using the CLI. Use the following command to run the CLI:
crowdin some-command [CONFIG OPTIONS] [OPTIONS]
Options
Here are the common options for all CLI commands:
Option | Description |
|---|---|
-h, --help | Show the help message and exit |
--no-colors | Disable colors and styles |
--no-progress | Disable progress on executed command |
-v, --verbose | Show more information on the command execution |
-V, --version | Print version information and exit |
--debug | Provide additional debugging information in case of errors |
Config options
Crowdin CLI config options provide an alternative way to pass options that can be configured via the configuration file. When config options are specified as command parameters, CLI considers them to have higher priority than the options specified in the configuration file. The config options also allow the CLI to be used without a configuration file.
Here are the common config options for all CLI commands:
Option | Description |
|---|---|
-T, --token=… | Personal Access Token required for authentication |
--base-url=… | Base URL of Crowdin server for API requests execution (https://api.crowdin.com for crowdin.com, https://{organization-name}.api.crowdin.com for Crowdin Enterprise) |
--base-path=… | Path to your project directory on a local machine (default: .) |
-i, --project-id=… | Numerical ID of the Crowdin project |
Some commands have their own config options.
Bash completion script
The bash completion script provided by Crowdin CLI is a utility that provides auto-completion suggestions for Crowdin CLI commands and options within the bash terminal. This script can significantly improve the productivity of users who frequently work with Crowdin CLI by reducing the need to manually type commands and options.
In order to use the Crowdin CLI bash completion script, the user needs to run it in their bash shell. This can be done by running the following command in a terminal:
source crowdin_completion
Once the script is sourced, the user can start typing a Crowdin CLI command, and then hit the Tab key to get a list of possible completions. The list will include all valid options and arguments for the command, based on the user's input.
Here's an example how to download the bash completion script from the latest release of a Crowdin CLI GitHub repository:
wget https://github.com/crowdin/crowdin-cli/releases/latest/download/crowdin_completion
Also, you can find the CLI completion script in the Standalone version zip archive.
Requirements
Check that 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.
If you don’t have Java installed, download it from Oracle’s website.