Translating product details by using the CLI

When you onboard software, you can translate certain details about your product by using the IBM Cloud® CLI plug-in. Run the get-translations command to download the language files. Then, edit those files to include your specific translations and upload them using the upload-translations command. For more information, see Getting started with the IBM Cloud CLI.

What product details can you translate?

The following information about your product can be translated:

Product name
Short and long description
Support process
Media captions
Feature titles and descriptions
Readme file

Downloading translation files

Run the get-translations command to download the language .json files.

ibmcloud catalog offering get-translations -c CATALOG_NAME -o PRODUCT_NAME --languages en,de,ja

Command options

-c: Specify the catalog name or ID.
-o: Specify the product name or ID.
--zip (optional): Downloads the translation files as a .zip file.
--languages: Provide a comma-separated list of languages to translate. If no languages are specified, all of them are downloaded. Valid options are de, en, es, fr, it, ja, ko, pt-BR, zh-Hans, and zh-Hant.

Edit the default values in each translation file with your specific translations for each language.

Uploading translation files

Run the upload-translations command to upload your translation files.

An English translation is required to upload other translations.

ibmcloud catalog offering upload-translations -c CATALOG_NAME -o PRODUCT_NAME --language-files en.json,de.json,ja.json

Command options

-c: Specify the catalog name or ID.
-o: Specify the product name or ID.
--language-files: Provide a comma-separated list of language files to upload. If no languages are specified, all of the available language files are uploaded. Valid options are de.json, en.json, es.json, fr.json, it.json, ja.json, ko.json, pt-BR.json, zh-Hans.json, and zh-Hant.json.