Config options

Here are the configuration options for JSON DeepL CLI.

jsondeepl/config.json

source

string required

The source language code for the translations. Refer to the supported source languages for the list of available language codes. E.g. en *case insensitive

target

string[] required

The target language codes for the translations. Refer to the supported target languages for the list of available language codes. E.g. ["de", "fr", "es"] *case insensitive

langDir

string required

E.g. ./i18n/locales - The directory where your locale JSON files are stored. This should point to the folder containing your translation files.

formality

'prefer_less' | 'prefer_more'

defaults to prefer_less
Specifies the formality level of the translation.

prefer_less: Translations will be casual tone where applicable.
prefer_more: Translations will be more formal where applicable.

options

object required

The description can be set as prop or in the default slot with full markdown support.

Prop	Default	Description
`prompt` `string`	`true`	set to `false` to disable console prompts for confirmations. useful for CI and automation.

.env

JSONDEEPL_API_KEY="your_deepl_api_key_here"

Usage

Learn how to use JSON DeepL CLI for translating JSON files.

HTTP

JSON DeepL API documentation for translating JSON objects and text by using HTTP requests.