インストール
必要条件
- 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
利用可能なコマンドの一覧が表示されれば、準備完了です。クイックスタートに進みましょう。