概要

このガイドでは、General Translation の CLI ツール（gtx-cli）を使ってプロジェクトを翻訳する手順を説明します。

この CLI ツールは、gt-next や gt-react に加え、next-intl や react-i18next などのサードパーティ製ライブラリを含むあらゆる i18n ライブラリに対応しています。

CLI ツールは、プロジェクトを General Translation の AI 翻訳サービスに接続する役割を担います。

CLI ツールの利用方法はいくつかあります。ユースケースに合ったセクションに移動してください。

インストール

CLI ツールをインストールするには、次のコマンドを実行します。

npm i gtx-cli

yarn add --dev gtx-cli

bun add --dev gtx-cli

pnpm add --save-dev gtx-cli

活用例

GT プロジェクトの翻訳

CLI ツールを使うと、gt-next または gt-react を利用したプロジェクトを翻訳できます。

このガイドは、gt-next または gt-react のチュートリアルに従って、すでにコードベースを gt-next もしくは gt-react 用にセットアップ済みであることを前提とします。

1. まず、プロジェクトの GT 設定を行います。

npx gtx-cli configure

2. 次に、General Translation の dashboard でプロジェクトを作成します。

プロジェクト作成後、本番用の APIキー を生成します。「API Keys」ページに移動し、「Create API Key」ボタンをクリックします。

3. その後、APIキー と Project ID を環境変数に追加します。

GT_API_KEY=<your-api-key>
GT_PROJECT_ID=<your-project-id>

4. 最後に翻訳コマンドを実行します。

npx gtx-cli translate

translate コマンドの詳細は、APIリファレンスを参照してください。

言語ファイルの翻訳（サードパーティ製 i18n ライブラリ／スタンドアロンの GT プロジェクト）

CLI ツールを使うと、サードパーティ製の i18n ライブラリ向け、またはスタンドアロン実装の gt-next もしくは gt-react で言語ファイルを翻訳できます。

多くの i18n ライブラリは、翻訳データの保存に JSON ファイルを使用します。 CLI ツールを使えば、これらの JSON ファイルを目的の言語に自動翻訳できます。

1. まず、プロジェクトの GT 設定を行う必要があります。

npx gtx-cli configure

このコマンドは、プロジェクトのルートに gt.config.json ファイルを作成し、プロジェクトのデフォルトlocaleや対応ロケールなどの基本的な設定を含めます。

2. 次に、General Translation のダッシュボードでプロジェクトを作成します。

プロジェクトを作成したら、本番用のAPIキーを生成します。「API Keys」ページに移動し、「Create API Key」ボタンをクリックします。

3. その後、APIキーとプロジェクトIDを環境変数に追加します。

GT_API_KEY=<your-api-key>
GT_PROJECT_ID=<your-project-id>

4. 最後に翻訳コマンドを実行します。

npx gtx-cli translate

GT プロジェクト向けの言語ファイルの生成

CLI ツールは、gt-next または gt-react を使用するプロジェクト向けに言語ファイルを生成できます。

これは、独自の翻訳プロバイダーを利用したい場合に有用です。

他の i18n ライブラリとは異なり、gt-next と gt-react はインライン翻訳をサポートしているため、各言語のキーと値を持つ従来型の JSON ファイル構造は存在しません。

そのため、テキストの変更を追跡するには、GT ライブラリがソースコード内に元のテキストのハッシュを保存します。

この内部データ構造（ハッシュを含む）は扱いが難しいため、CLI ツールはプロジェクト向けの言語ファイルを生成する便利なコマンドを提供します。

1. まず、プロジェクトの GT 設定を行う必要があります。

npx gtx-cli configure

GT CDN に翻訳を保存するかどうか確認されたら、「No」を選択してください。

2. 次を実行します:

npx gtx-cli generate

このコマンドは、デフォルトのlocale向けのソースファイルと、プロジェクトで設定しているその他すべての対応ロケール向けのソースファイルを生成します。

各ファイルの内容は同一で、プロジェクト内の既存の翻訳がある場合はそれらとマージされます。

generate コマンドの詳細は APIリファレンス を参照してください。

注意事項

• gtx-cli translate は、プロジェクトの翻訳を自動生成するために使用します。
• サードパーティのi18nライブラリを使用している場合、プロジェクトに変更があるたびに、すべての翻訳用JSONファイルを自動更新できます。ビルドコマンドの実行前に、ビルドまたはCDプロセス（継続的デリバリー／継続的デプロイ）へ gtx-cli translate コマンドを追加するだけで、翻訳が自動的にプロジェクトへ反映されます。

次のステップ

• 詳しくは、CLI APIリファレンスをご覧ください。