pandodao/i18n-cli

A CLI tool that utilizes the OpenAI API to translate JSON-based locale files

i18n-cli

A command-line interface (CLI) tool that utilizes the OpenAI API to translate locale files based on JSON format.

Install

go install github.com/pandodao/i18n-cli@latest

Usage

export OPENAI_API_KEY=YOUR_API_KEY
i18n-cli translate \
  --dir ./locales \
  --source ./locales/en-US.json \
  --independent ./independent.json

in which,

• --dir: This flag specifies the directory where the locale files are located. The value ./locales specifies that the locales directory is located in the current working directory.
• --source: This flag specifies the source locale file to be used as a reference for translation.
• --independent: This flag specifies the independent locale file to be used as a reference for translation.

i18n-cli reads the directory containing locale files, retrieves translations from OpenAI, and then writes the translated content back to the same files.

To have i18n-cli translate the content of a JSON locale file, any existing values will be ignored.

If you want i18n-cli to translate a specific value, you can add a "!" at the beginning of the string. Alternatively, you can delete the key/value pair from the JSON file to have i18n-cli generate a new translation.

i18n-cli's Issues

Allow translation for nested files

Hello I wanted to try your cli but it doesn't work with nested translations.

Is it possible to add it ?

Thank you

won't install ...

go install -x github.com/pandodao/i18n-cli@latest
# get https://proxy.golang.org/github.com/@v/list
# get https://proxy.golang.org/github.com/pandodao/i18n-cli/@v/list
# get https://proxy.golang.org/github.com/pandodao/@v/list
# get https://proxy.golang.org/github.com/pandodao/@v/list: 404 Not Found (0.110s)
# get https://proxy.golang.org/github.com/@v/list: 404 Not Found (0.136s)
# get https://proxy.golang.org/github.com/pandodao/i18n-cli/@v/list: 200 OK (0.138s)
WORK=/var/folders/cm/cmj5bhyd3652kbz69v3k4xc80000gn/T/go-build3962320052

go version go version go1.20.3 darwin/arm64

What is --independent?

I am running under Windows.

Your screenshot shows MacOS running it from the command-line without the --independent parameter, but the usage documentatation states:

export OPENAI_API_KEY=YOUR_API_KEY
i18n-cli translate \
  --dir ./locales \
  --source ./locales/en-US.json \
  --independent ./independent.json

Since I am under Windows, I am using SET OPENAI_API_KEY= instead.

After this, I attempt to run:

i18n-cli translate --dir ./i18n --source ./i18n/en.json

This results in two errors:

failed to get language: independent.json
failed to get language: test.json

First, what is independent.json? The documents don't say much about what this is or what it is supposed to contain. Right now I have three files in my i18n folder ... en.json, which has all the translations, and two empty ones, fr.json and es.json, that I would like populated. Is that correct?

What is independent.json? And for that matter, what is test.json?

If I create an empty independent.json file to test, and then run:

i18n-cli translate --dir ./i18n --source ./i18n/en.json --independent ./i18n/independent.json

I get the same error as above.

My en.json is structured as such ... is this not what this program is meant to deal with?

{
  "LOGIN": {
    "FORGOT_USERNAME": "Forgot your username?",
    "FORGOT_PASSWORD": "Forgot your password?",
  },
  "CUSTOMERSEARCH": {
    "CONTACT_EMAIL": "Contact Email",
    "BILLING_EMAIL": "Billing Email",
  }
}