Getting started

Installation

npm install champo-ai --save-dev

Configuration

Create a new API key at https://champo.ai/api-keys and export it.

export CHAMPO_API_KEY=[YOUR_EW_API_KEY]

Create a new project: https://champo.ai/editor/projects

Add target languages: https://champo.ai/editor/projects

Create a config JSON file at the root of your project ./config.champo.json.

{
  "projectName": "YOUR ChampoAI PROJECT_NAME",
  
  "translationFolder": "./translations",
  // OR
  "sourceFile": "./translations/fr-FR.json",

  // optionnal (prefix to avoid file replacement) 
  "aiGeneratedPrefix": "ai-generated_",
  
  // optionnal (only have effect if "translationFolder" is set)
  "excludedFiles": ["file_to_exclude.ts"],
  "includedFiles": ["file_to_translate.json"]
}

Generating I18n file translations

1. Sync your I18n source files

Run npx champo push to upload your source I18n JSON files.

or use the File Editor on ChampoAI to import JSON source files.

1. Translate missing values

Use npx champo translate to generate missing translations.

You or your Project Manager can generate all missing translations directly on the File Editor.

You can now invite traducers to review and improve generated translations:

1. Download translation results

Run npx champo pull to download all targeted languages I18n files directly into your project.

Maintain workflow translations

To maintain your translation you just have to repeat the same command lines you used for the first translation:

1. Sync your updated I18n source files

npx champo push (this command will update existing source keys and create missing ones)

1. Translate missing values

npx champo translate (this command will translate only missing and updated source keys)

1. Download result

npx champo pull (this will command replace all existing I18n translations by new ones)