Installation
Requirements
- Node.js 20.11+ (native ESM)
- A translation API key (see below)
Install
- npm
- npx (no install)
- pnpm
- yarn
npm install --save-dev champollion
npx champollion sync
pnpm add -D champollion
yarn add --dev champollion
Get an API Key
Champollion needs a translation backend. Pick one:
| Provider | Environment Variable | Best For |
|---|---|---|
| OpenRouter (recommended) | OPENROUTER_API_KEY | Content-heavy projects, Markdown, 200+ models |
| Gemini (free tier) | GEMINI_API_KEY | Zero-cost start, good quality |
| OpenAI | OPENAI_API_KEY | Direct GPT-4o access |
| Anthropic | ANTHROPIC_API_KEY | Direct Claude access, nuanced text |
| DeepL | DEEPL_API_KEY | European languages, built-in formality |
| Google Translate | GOOGLE_TRANSLATE_API_KEY | High-volume key-value pairs, 130+ languages |
| Microsoft Translator | MICROSOFT_TRANSLATOR_API_KEY | Azure, 100+ languages |
| LibreTranslate | LIBRETRANSLATE_API_URL | Self-hosted, privacy-first |
- OpenRouter (recommended)
- Google Translate
OpenRouter provides a unified API for 200+ LLM models. Free tier available.
# Sign up at https://openrouter.ai, then:
export OPENROUTER_API_KEY=sk-or-v1-...
Or add to .env.local:
OPENROUTER_API_KEY=sk-or-v1-your-key-here
Best for: content-heavy projects, Markdown translation, and projects needing content-aware shielding (code blocks, shortcodes, interpolation variables).
export GOOGLE_TRANSLATE_API_KEY=...
Best for: high-volume key-value string pairs (130+ languages). Not recommended for Markdown content — Google Translate has no awareness of code blocks, shortcodes, or interpolation variables.
:::tip Smart detection
If only GOOGLE_TRANSLATE_API_KEY is set (no OpenRouter key), champollion auto-switches to Google Translate. No config change needed.
:::
Verify Installation
npx champollion --help
You should see the list of available commands. You're ready for the Quick Start.