translatorAPI

Java App to connect to the public endpoint of DeepL and translate texts conveniently from the command line terminal.

URLs

• DeepL API Docs
• API Endpoints

CLI options

Option	Description
-mode	Execution mode {quota | translate}
-api-key	DeepL free api key (Should end with :fx)
-text	Text for translation via DeepL
-target	Target language
-from	Source language
-context	Additional context which may enhance the translation

Quota mode

Will return billed characters for current token. It will display the consumed percentage as response:

java -jar translator-api.jar -mode quota -api-key <api-key:fx>
Quota: 3819/500000 >> 0.76%

Translate mode

Will return a translated message back to user:

java -jar translator-api.jar -mode translate -text "Construir una API de traducción" -api-key $API_KEY -target GB
Building a translation API

Supported languages

DeepL supported language list

Building the package

Pre-requisites

Optional: install java & maven.

Originally developed with Java 17.

Get a free API key from DeepL. Start here!

mvn clean package

export API_KEY = "<API-KEY>"
java -jar translator-api.jar \
    -mode translate \
    -text "Construir una API de traducción" \
    -api-key $API_KEY

Add as shortcut to the shell

Edit .bashrc (or similar) shell script and follow the next example:

DEEPL="<API-KEY>"

# Launches Java app to connect to the DeepL API
translator() {
input=$1
target_language=$2
from_language=$3
output="$(java -jar $HOME/.scripts/translator-api.jar -mode translate -text "${input}" -api-key $DEEPL -target $target_language -from $from_language)"
echo -e "${output}"
}

# Next functions works as shortcuts.
# tr-es "Translate this to Spanish\!"

tr-gb(){
input="${*}"
translator "${input}" "GB" "ES"
}

tr-us(){
input="${*}"
translator "${input}" "US" "ES"
}

tr-es(){
input="${*}"
translator "${input}" "ES" "EN"
}

Piping the output to a clipboard is rather convenient, just paste the output directly where it's need it.

Add as shortcut for git

Edit .gitconfig file, located under $HOME dir.

[alias]
    tr = "!f () { msg=$(java -jar $HOME/.scripts/translator-api.jar -mode translate -text \"$1\" -api-key <API-KEY> -target GB -from ES) && git commit -m \"$msg\"; }; f"

Adding the API-KEY in a common file could make things easier if you need to track the api-key across several scripts.

Create a .keys file under $HOME:

DEEPL="<your-api-key>"

Now it can be sourced from .gitconfig and .bashrc:

[alias]
    tr = "!f () { . $HOME/.keys && msg=$(java -jar $HOME/.scripts/translator-api.jar -mode translate -text \"$1\" -api-key $DEEPL -target GB -from ES) && git commit -m \"$msg\"; }; f"

Use the new shortcut when adding commit messages:

git add new-file
git tr "Agregar un nuevo fichero"
[branch b1f4446] Add new file
 1 file changed, 0 insertions(+), 0 deletions(-)
 create mode 100644 file