使用ガイド

概要

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

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

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

CLI ツールの使い方はいくつかありますので、ご自身のユースケースに合ったセクションをご参照ください。

インストール

CLIツールをインストールするには、次のコマンドを実行してください：

npm i --save-dev 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ダッシュボードでプロジェクトを作成する必要があります。

プロジェクトを作成した後、本番用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

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

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

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

ほとんどのi18nライブラリは、翻訳データを保存するためにJSONファイルに依存しています。 CLIツールを使用して、これらのJSONファイルを希望する言語に自動的に翻訳できます。

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

npx gtx-cli configure

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

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

このコマンドは、デフォルトロケール用のソースファイルと、プロジェクトで設定した他のすべてのロケール用のファイルを生成します。

各ファイルの内容は同じで、プロジェクト内の既存の翻訳とマージされます。

generate コマンドの詳細については、APIリファレンス をご覧ください。

注意事項

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

次のステップ

• 詳細については、CLI API リファレンスをご覧ください。
• 開発中にライブ翻訳（ホットリロードのようなもの）を確認したい場合は、<T> コンポーネントをチェックしてください。