使用ガイド
General Translationのコマンドラインツールの使用ガイド
概要
このガイドでは、General TranslationのCLIツール（gtx-cli）を使用してプロジェクトを翻訳するプロセスを説明します。
CLIツールは、gt-next、gt-react、またはnext-intlやreact-i18nextなどのサードパーティライブラリを使用しているかどうかにかかわらず、あらゆるi18nライブラリと互換性があります。
CLIツールは、プロジェクトをGeneral TranslationのAI翻訳サービスに接続する役割を担っています。
CLIツールを使用するにはいくつかの方法があります。あなたのユースケースに関連するセクションに移動してください。
インストール
CLIツールをインストールするには、次のコマンドを実行します：
ユースケース
GTプロジェクトの翻訳
CLIツールを使って、gt-next または gt-react を利用しているプロジェクトを翻訳できます。
このガイドでは、gt-next または gt-react のチュートリアルに従って、すでにコードベースのセットアップが完了していることを前提としています。
- まず、プロジェクトのGT設定を構成する必要があります。
このコマンドは、ダッシュボードを通じて自動的にAPIキーとプロジェクトIDを生成します。
ただし、APIキーとプロジェクトIDを手動で設定したい場合は、以下のステップ2と3に従ってください。
- 次に、General Translationダッシュボードでプロジェクトを作成します。
プロジェクト作成後、本番用APIキーを生成する必要があります。「API Keys」ページに移動し、「Create API Key」ボタンをクリックしてください。
- その後、APIキーとプロジェクトIDを環境変数に追加します。
- 最後に、翻訳コマンドを実行します。
デフォルトでは、CLIツールは翻訳をGeneral Translation CDNに公開し、プロジェクトですぐに利用できるようにします。
この動作を無効にしたい場合（例：別のソースから翻訳を読み込む場合）は、コマンドに --no-publish フラグを追加してください。
translate コマンドの詳細については、APIリファレンスをご覧ください。
言語ファイルの翻訳（サードパーティi18nライブラリやスタンドアロンGTプロジェクト）
CLIツールを使って、サードパーティのi18nライブラリ用の言語ファイルや、gt-next または gt-react のスタンドアロン実装の言語ファイルを翻訳できます。
多くのi18nライブラリは、翻訳データの保存にJSONファイルを利用しています。 CLIツールを使うことで、これらのJSONファイルを自動的に希望する言語に翻訳できます。
- まず、プロジェクトのGT設定を構成する必要があります。
このコマンドは、プロジェクトのルートに gt.config.json ファイルを作成し、プロジェクトのデフォルトロケールや対応ロケールなどの基本設定を含みます。
このコマンドは、ダッシュボードを通じて自動的にAPIキーとプロジェクトIDを生成します。
ただし、APIキーとプロジェクトIDを手動で設定したい場合は、以下のステップ2と3に従ってください。
- 次に、General Translationダッシュボードでプロジェクトを作成します。
プロジェクト作成後、本番用APIキーを生成する必要があります。「API Keys」ページに移動し、「Create API Key」ボタンをクリックしてください。
- その後、APIキーとプロジェクトIDを環境変数に追加します。
- 最後に、翻訳コマンドを実行します。
デフォルトでは、CLIツールは gt.config.json ファイルの files プロパティに従って翻訳対象ファイルを探します。
また、gt.config.json ファイルで指定された defaultLocale をソース言語として使用します。
翻訳されたファイルは、gt.config.json ファイルで指定された出力先に保存されます。
files プロパティの詳細については、設定ドキュメントをご覧ください。
GTプロジェクト用の言語ファイルを生成する
CLIツールを使って、gt-next または gt-react を利用しているプロジェクトの言語ファイルを生成できます。
このユースケースは、独自の翻訳プロバイダーを使用したい場合に便利です。
他のi18nライブラリとは異なり、gt-next と gt-react はインライン翻訳をサポートしており、各言語ごとにキーと値を持つ従来のJSONファイル構造はありません。
そのため、テキストの変更を追跡するために、GTライブラリはソースコード内の元のテキストのハッシュを保存します。
この内部データ構造（ハッシュを含む）は扱いが難しいため、CLIツールはプロジェクト用の言語ファイルを生成する便利なコマンドを提供しています。
- まず、プロジェクトのGT設定を構成する必要があります。
GT CDNに翻訳を保存するかどうか尋ねられたら、「No」を選択してください。
- 次のコマンドを実行します。
このコマンドは、デフォルトロケール用のソースファイルと、プロジェクトで設定した他のすべてのロケール用のファイルを生成します。
各ファイルの内容は同じで、プロジェクト内の既存の翻訳とマージされます。
generate コマンドの詳細については、APIリファレンス をご覧ください。
GTプロジェクト用の言語ファイルの生成
CLIツールは、gt-nextまたはgt-reactを使用するプロジェクト用の言語ファイルを生成するために使用できます。
このユースケースは、独自の翻訳プロバイダーを使用したい場合に役立ちます。
他のi18nライブラリとは異なり、gt-nextとgt-reactはインライン翻訳をサポートしているため、各言語のキーと値を含む従来のJSONファイル構造はありません。
つまり、テキストの変更を追跡するために、GTライブラリはソースコード内に元のテキストのハッシュを保存します。
この内部データ構造（ハッシュを含む）は扱いにくいため、CLIツールはプロジェクト用の言語ファイルを生成するための便利なコマンドを提供しています。
- まず、プロジェクトでCLIツールを初期化する必要があります。
「言語ファイルはどこに保存されていますか？」と尋ねられたら、「Local」オプションを選択してください。
- 実行：
このコマンドは、デフォルトロケールと、プロジェクト用に設定した他のすべてのロケールのソースファイルを生成します。
各ファイルの内容は同じであり、プロジェクト内の以前の翻訳とマージされます。
generateコマンドの詳細については、APIリファレンスを参照してください。
注意
gtx-cli translateは、プロジェクトの翻訳を自動的に生成するために使用されます。- サードパーティのi18nライブラリを使用している場合、プロジェクトが変更されるたびにすべての翻訳JSONファイルを自動的に更新できます。ビルドコマンドの前にビルドまたはCDプロセスに
gtx-cli translateコマンドを追加するだけで、プロジェクトに自動的に翻訳を追加できます。