Skip to main content

crowdin init

Description​

Generate Crowdin CLI configuration skeleton

Synopsis​

crowdin init [CONFIG OPTIONS] [OPTIONS]

Options​

-d, --destination=…
Place where the configuration skeleton should be saved. Default: crowdin.yml

-T, --token=…
Personal access token required for authentication

-i, --project-id=…
Numeric ID of the project

--base-path=…
Path to your project directory on a local machine

--base-url=…
Base URL of Crowdin server for API requests execution

-s, --source=…
Path to the source files

-t, --translation=…
Path to the translation files

--[no-]preserve-hierarchy
Choose whether to save the directory hierarchy in the Crowdin project

--quiet
Do not ask for interactive input prompts

-V, --version
Display version information and exit

-h, --help
Display help message and exit

--no-progress
Disable progress on executed command

-v, --verbose
Provide more information about the command execution

--no-colors
Disable colors and styles

Examples​

Instead of interactive mode, you can also pass the parameters directly to the command:

crowdin init \
  --base-path "." \
  --base-url "https://api.crowdin.com" \
  -i "1" \
  -T "personal-access-token" \
  -s "/locales/**/*" \
  -t "/%two_letters_code%/%original_file_name%" \
  --preserve-hierarchy

As a result, the configuration file will be filled with the passed parameters.

Notes​

Warning: The browser authorization token you receive has an expiration period of 30 days. This means that after 30 days, the token will expire and you need to generate a new token to continue using CLI.