DeepL-translation of asset meta-data for the Storyblok CMS

An npx CLI tool to automatically translate meta-information of assets (title, alt-text, copyright and source) of a Storyblok CMS space using the DeepL API.

Use case

In Storyblok multi-language support for asset-meta-data in the asset library is only available in the Enterprise plan.

Translation of meta-data is however still possible on all plans via field-level-translation by making a (single- or multi-)asset-field translatable. This tool performs automatic translations for these cases.

Requirements

• A Storyblok space.
• A DeepL API account (Free or Pro).

Installation

# simply auto-download and run via npx
$ npx storyblok-translate-asset-meta

# or install globally
$ npm install -g storyblok-translate-asset-meta

# or install for project using npm
$ npm install storyblok-translate-asset-meta

# or install for project using yarn
$ yarn add storyblok-translate-asset-meta

# or install for project using pnpm
$ pnpm add storyblok-translate-asset-meta

Usage

Call npx storyblok-translate-asset-meta with the following options:

Options

--token <token>                (required) Personal OAuth access token created
                               in the account settings of a Stoyblok user.
                               (NOT the Access Token of a Space!)
                               Alternatively, you can set the STORYBLOK_OAUTH_TOKEN environment variable.
--space <space_id>             (required) ID of the space to backup
                               Alternatively, you can set the STORYBLOK_SPACE_ID environment variable.
--deepl-api-key <key>          (required) DeepL API Key
                               Alternatively, you can set the DEEPL_API_KEY environment variable.
--region <region>              Region of the space. Possible values are:
                               - 'eu' (default): EU
                               - 'us': US
                               - 'ap': Australia
                               - 'ca': Canada
                               - 'cn': China
                               Alternatively, you can set the STORYBLOK_REGION environment variable.
--fields <fields>              Comma seperated list of meta-data fields to translate.
                               Defaults to all ("alt,title,copyright,source").
                               (e.g. --fields "alt,title")
--source-lang <source-lang>    Source locale to translate from (=default Storyblok locale).
                               Defaults uses DeepL auto-detection.
--content-types <types>        Comma seperated list of content/component types to process. Defaults to all.
                               (e.g. --content-types "page,news-article")
--skip-stories <stories>       Comma seperated list of the full-slugs of stories to skip.
                               (e.g. --skip-stories "home,about-us")
--only-stories <stories>       Comma seperated list of the full-slugs of stories you want to limit processing to.
                               (e.g. --only-stories "about-us")
--locales <locales>            Comma seperated languages to process. Leave empty for all languages.
                               (e.g. --locales "de,fr")
--overwrite                    Overwrites existing translations. Defaults to false.
--publish                      Publish stories after updating. Defaults to false.
                               WARNING: May publish previously unpublished stories.
--dry-run                      Only display the changes instead of performing them. Defaults to false.
--verbose                      Show detailed output for every processed asset.
--help                         Show this help

Storyblok OAuth token, space-id and region as well as the DeepL API Key can be set via environment variables. You can also use a .env file in your project root for this (see .env.example).

Minimal example

npx storyblok-translate-asset-meta --token 1234567890abcdef --space 12345 --deepl-api-key 1234567890abcdef

Maximal example

npx storyblok-translate-asset-meta \
    --token 1234567890abcdef \
    --deepl-api-key 1234567890abcdef \
    --region us \
    --fields "alt,title" \
    --source-lang en \
    --content-types "page,news-article" \
    --skip-stories "home" \
    --locales "de,fr" \
    --overwrite \
    --publish \
    --dry-run \
    --verbose

License

This package is open-sourced software licensed under the MIT license.