Pre-requisites

- DeepL auth key
- English text in JSON or RESW format

Usage

1. Install @elgato/translate

``
npm install @elgato/translate -g
`

2. Run the initialization wizard
`
translate init
`

3. Translate resources

`
translate -k
`

Configuration

Main configuration that defines the source texts, and target languages.

| Name | Type | Description | Required |
| ----------- | ----------------------------------------------------------------- | ------------------------------ | -------- |
| source | string | Path to the English text. | ✅ |
| targets | TargetLanguage[] | Languages to translate to. | ✅ |
| formality | "less", "prefer_less", "default", "prefer_more", "more" | Formality of the translations. | |

$3

Target languages the source texts will be translated to.

| Name | Type | Description | Required |
| ----------- | ----------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------- |
| code | string | Language code, learn more. | ✅ |
| formality | "less", "prefer_less", "default", "prefer_more", "more" | Formality of the translations. | |
| file | string | Output file. | |
| glossary | string | DeepL glossary identifier. | |
| overrides | Override[] | Manual overrides. | |

$3

Allows for manual translations.

| Name | Type | Description | Required |
| ------ | -------- | ----------------------------------------------------------- | -------- |
| text | string | Text that should not be translated with the remote service. | ✅ |
| out | string | Output text; when unspecified, the original text is output. | |

CLI Options

-k, --auth-key

- Default: undefined (required)
- Type: String

The DeepL authentication key used to translate text with DeepL

-c, --config

- Default: translations.config.json`
- Type: String

Path to the configuration file.