使用ガイド
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-nextまたはgt-reactを使用するようにセットアップしていることを前提としています。
- まず、プロジェクトでCLIツールを初期化する必要があります。
- 次に、General Translationダッシュボードでプロジェクトを作成する必要があります。
プロジェクトを作成した後、本番用APIキーを生成する必要があります。「APIキー」ページに移動し、「APIキーを作成」ボタンをクリックします。
- 次に、APIキーとプロジェクトIDを環境変数に追加します。
- 最後に、翻訳コマンドを実行します。
デフォルトでは、CLIツールは翻訳をGeneral Translation CDNに公開するため、プロジェクトですぐに使用できるようになります。
この動作を無効にしたい場合（例えば、別のソースから翻訳を読み込む場合）、コマンドに--no-publishフラグを追加してください。
translateコマンドの詳細については、APIリファレンスを参照してください。
言語ファイルの翻訳（サードパーティi18nライブラリまたはスタンドアロンGTプロジェクト）
CLIツールを使用すると、サードパーティi18nライブラリ用の言語ファイルや、gt-nextまたはgt-reactのスタンドアロン実装で翻訳できます。
ほとんどのi18nライブラリは、翻訳データを保存するためにJSONファイルに依存しています。 CLIツールを使用して、これらのJSONファイルを希望の言語に自動的に翻訳することができます。
- まず、プロジェクトでCLIツールを初期化する必要があります。
このコマンドは、プロジェクトのデフォルトロケールとサポートされているロケールなどの基本的な設定を含むgt.config.jsonファイルをプロジェクトのルートに作成します。
- 次に、General Translationダッシュボードでプロジェクトを作成する必要があります。
プロジェクトを作成した後、本番用APIキーを生成する必要があります。「APIキー」ページに移動し、「APIキーを作成」ボタンをクリックします。
- 次に、APIキーとプロジェクトIDを環境変数に追加します。
- 最後に、翻訳コマンドを実行します。
デフォルトでは、CLIツールはgt.config.jsonファイルで指定されたtranslationsDirディレクトリ内の翻訳対象の言語ファイルを探します。
gt.config.jsonファイルで指定されたdefaultLocaleをソース言語として使用します。
また、翻訳をGeneral Translation CDNに公開するため、プロジェクトですぐに使用できるようになります。
この動作を無効にしたい場合は、コマンドに--no-publishフラグを追加してください。
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コマンドを追加するだけで、プロジェクトに自動的に翻訳を追加できます。
次のステップ
- 詳細についてはCLI APIリファレンスを参照してください。
- 開発中にライブ翻訳を確認したい場合（ホットリロードのようなもの）、
<T>コンポーネントをチェックしてください。