クイックスタート

Lingo.dev CLIを使い始める

はじめに

Lingo.dev CLIは、AIでアプリやコンテンツを翻訳するための無料のオープンソースCLIです。このクイックスタートガイドでは、数分でLingo.dev CLIを導入して使い始める方法を説明します。

ステップ1. プロジェクトの初期化

  1. プロジェクトディレクトリに移動します：

    cd <your-project-directory>

  2. 次のコマンドを実行します：

    npx lingo.dev@latest init

  3. 表示されるプロンプトに従います。

CLIは翻訳パイプラインを設定するためのi18n.jsonファイルを作成します。

ステップ2. バケットの設定

「i18n.json」ファイルで、少なくとも1つの_バケット_を設定します：

{
  "$schema": "https://lingo.dev/schema/i18n.json",
  "version": 1.8,
  "locale": {
    "source": "en",
    "targets": ["es"]
  },
  "buckets": {
    "json": {
      "include": ["locales/[locale].json"]
    }
  }
}

バケットは、Lingo.dev CLIが翻訳可能なコンテンツを抽出するために使用するパーサーを決定します。例えば、"json"バケットはJSONファイルを翻訳するために特別に設計されています。

バケットの設定では、翻訳すべきファイルを指定する1つ以上のincludeパターンを定義する必要があります。（オプションで、さらに制御するためのexcludeパターンを指定することもできます。）

注意点：

  • 特定のバケットのincludeパターンには特別な[locale]プレースホルダーを含める必要がありますが、他のケースではこのプレースホルダーは厳密に許可されていません。
  • 一部のバケットはキーロックなどの追加機能をサポートしています。

各バケットの正確な要件については、JSONやCSVなどの各バケットのドキュメントを参照してください。

ステップ3. LLMプロバイダーの設定

Lingo.dev CLIがファイルからコンテンツを抽出した後、翻訳のために大規模言語モデル（LLM）に送信し、翻訳されたコンテンツをファイルシステムに書き戻します。

LLMプロバイダーとして、当社が提供するホスト型プラットフォームLingo.dev Engineの使用を推奨していますが、これは必須ではありません。CLIはAnthropicやOpenAIなど、多数のサードパーティプロバイダーをサポートしています。

Lingo.dev エンジン

  1. Lingo.dev エンジンにログインしてください。
  2. プロジェクトページに移動します。
  3. API キー > コピーをクリックします。
  4. LINGODOTDEV_API_KEY環境変数にAPIキーを値として設定します。

サードパーティプロバイダー

  1. サポートされているプロバイダーの一つからAPIキーを取得します。

  2. APIキーを値として環境変数を設定します：

    • Anthropicを使用する場合は、ANTHROPIC_API_KEYを設定
    • Googleを使用する場合は、GOOGLE_API_KEYを設定
    • Mistralを使用する場合は、MISTRAL_API_KEYを設定
    • OpenAIを使用する場合は、OPENAI_API_KEYを設定
    • OpenRouterを使用する場合は、OPENROUTER_API_KEYを設定

  3. i18n.jsonファイルに、以下のプロパティを持つproviderオブジェクトを追加します：

    • id - LLMプロバイダーのID（例：openai）。
    • model - そのLLMプロバイダーの特定のモデルのID（例：gpt-4o-mini）。
    • prompt - すべてのLLMリクエストと共に送信されるプロンプト。ソースロケールとターゲットロケールのプレースホルダー値として{source}と{target}を使用します。これらは実行時に置き換えられます。

    例：

    {
  "$schema": "https://lingo.dev/schema/i18n.json",
  "version": 1.8,
  "locale": {
    "source": "en",
    "targets": ["es"]
  },
  "buckets": {
    "json": {
      "include": ["locales/[locale].json"]
    }
  },
  "provider": {
    "id": "openai",
    "model": "gpt-4o-mini",
    "prompt": "Translate the provided text from {source} to {target}."
  }
}

利用可能なオプションの詳細については、i18n.jsonを参照してください。

ステップ4. 翻訳の生成

プロジェクトディレクトリで、次のコマンドを実行します：

npx lingo.dev@latest run

CLIは以下を実行します：

  1. i18n.jsonファイルに基づいて、翻訳が必要なファイルを決定します。
  2. ファイルから翻訳可能なコンテンツを抽出します。
  3. 設定されたLLMプロバイダーに翻訳のためにコンテンツを送信します。
  4. 翻訳されたコンテンツをファイルシステムに書き込みます。
  5. 翻訳されたコンテンツを追跡するためのi18n.lockファイルを作成します。

完全なライフサイクルの詳細については、動作の仕組みを参照してください。

次のステップ

CLIで利用可能なコマンド、オプション、フラグの完全なリストについては、CLIコマンドをご覧ください。