安装
要求
- Node.js 20.11+（原生 ESM）
- 翻译 API 密钥（见下文）
安装
- npm
- npx (no install)
- pnpm
- yarn
npm install --save-dev champollion
npx champollion sync
pnpm add -D champollion
yarn add --dev champollion
获取 API 密钥
Champollion 需要一个翻译后端。选择一个：
| 提供商 | 环境变量 | 最适合 |
|---|---|---|
| OpenRouter（推荐） | OPENROUTER_API_KEY | 内容丰富的项目、Markdown、200+ 模型 |
| Gemini（免费层） | GEMINI_API_KEY | 零成本开始、质量良好 |
| OpenAI | OPENAI_API_KEY | 直接访问 GPT-4o |
| Anthropic | ANTHROPIC_API_KEY | 直接访问 Claude、细致文本处理 |
| DeepL | DEEPL_API_KEY | 欧洲语言、内置正式程度 |
| Google Translate | GOOGLE_TRANSLATE_API_KEY | 大量键值对、130+ 语言 |
| Microsoft Translator | MICROSOFT_TRANSLATOR_API_KEY | Azure、100+ 语言 |
| LibreTranslate | LIBRETRANSLATE_API_URL | 自托管、隐私优先 |
- OpenRouter (recommended)
- Google Translate
OpenRouter 为 200+ 个 LLM 模型提供统一 API。提供免费层。
# Sign up at https://openrouter.ai, then:
export OPENROUTER_API_KEY=sk-or-v1-...
或添加到 .env.local：
OPENROUTER_API_KEY=sk-or-v1-your-key-here
最适合：内容丰富的项目、Markdown 翻译，以及需要内容感知屏蔽（代码块、短代码、插值变量）的项目。
export GOOGLE_TRANSLATE_API_KEY=...
最适合：大量键值字符串对（130+ 语言）。不推荐用于 Markdown 内容 — Google Translate 不能识别代码块、短代码或插值变量。
:::tip 智能检测
如果仅设置了 GOOGLE_TRANSLATE_API_KEY（没有 OpenRouter 密钥），champollion 会自动切换到 Google Translate。无需更改配置。
:::
验证安装
npx champollion --help
你应该看到可用命令的列表。你已准备好进行快速开始。