README.md

DeepL Translate

An unofficial Node package to translate text using DeepL.

Online Service

https://deeplx.vercel.app/translate

Installation

# npm
npm i deeplx

# pnpm
pnpm add deeplx

# yarn
yarn add deeplx

Usage

Supported languages

Currently the following languages are supported:

Abbreviation	Language	Writing in own language
BG	Bulgarian	Български
ZH	Chinese	中文
CS	Czech	Česky
DA	Danish	Dansk
NL	Dutch	Nederlands
EN	English	English
ET	Estonian	Eesti
FI	Finnish	Suomi
FR	French	Français
DE	German	Deutsch
EL	Greek	Ελληνικά
HU	Hungarian	Magyar
IT	Italian	Italiano
JA	Japanese	日本語
LV	Latvian	Latviešu
LT	Lithuanian	Lietuvių
PL	Polish	Polski
PT	Portuguese	Português
RO	Romanian	Română
RU	Russian	Русский
SK	Slovak	Slovenčina
SL	Slovenian	Slovenščina
ES	Spanish	Español
SV	Swedish	Svenska

You can either input the abbreviation or the language written in english.

Command line tool

Help

deeplx --help

Usage: deeplx [options]

An unofficial Node package to translate text using [DeepL](https://www.deeplx.com).

Options:
  -V, --version                  output the version number
  -sl, --source-language <text>  Source language of your text
  -tl, --target-language <text>  Target language of your desired text
  --formal                       Use formal or informal tone in translation (default: false)
  -t, --text                     Text to be translated
  -f, --file                     File to be translated
  -h, --help                     display help for command

Example 1

This will translate a Spanish (ES) text into Russian (RU):

deeplx -tl russian -t "¡Buenos días!"

Доброе утро!

Example 2

This will translate the file (test.txt) text from Italian (IT) into Portuguese (PT):

deeplx -tl PT -f test.txt

Example 3

This will translate a Spanish (ES) text into Russian (RU) in formal tone:

deeplx -tl RU --text "¿Cómo te llamas?" --formal

Как Вас зовут?

Note: informal would be "Как тебя зовут?"

Example 4

This will translate a Japanese (JP) text into German (DE) in informal tone:

deeplx -tl DE --text "お元気ですか？" --formal false

Wie geht es dir?

Note: formal would be "Wie geht es Ihnen?"

Node library

Example 1

This will translate a Chinese (ZH) text into Dutch (NL):

import { translate } from 'deeplx'

translate('你好', 'NL')

'Hallo'

Example 2

This will translate a danish text into german in informal tone:

import { translate } from 'deeplx'

translate('Ring til mig!', 'german', 'danish', undefined, undefined, false)

'Ruf mich an!'