# gt: General Translation CLI tool: クイックスタート
URL: https://generaltranslation.com/ja/docs/cli/quickstart.mdx
Docs index: https://generaltranslation.com/llms.txt
Description: General Translation CLI を使って、コマンドラインからプロジェクトを翻訳します。

General Translation CLI (`gt`) は、コマンドラインからプロジェクトの国際化を設定し、翻訳できるツールです。

[`gt-react`、`gt-next`、`gt-react-native`](/docs/react/overview) に加え、`next-intl` や `i18next` などのサードパーティ製 i18n ライブラリ、さらに JSON、YAML、Markdown、MDX などのスタンドアロンファイルにも対応しています。

## CLIでできること [#what-it-does]

CLI を使うと、次のことを直接行えます。

* **初期設定**: 依存関係をインストールし、フレームワークとの連携を設定して、`gt.config.json` を作成します。
* **翻訳**: ソースコンテンツを General Translation API に送信し、結果をコードベースまたは CDN に保存します。
* **CI の構成要素**: 分離されたパイプラインの各 stage 間で、翻訳のアップロード、エンキュー、ダウンロードを行います。
* **API アクセス**: [`gt api`](/docs/cli/reference/commands/api) を使って、認証付きの raw リクエストや同梱の OpenAPI ディスカバリを利用します。
* **検証**: API を呼び出さずに、プロジェクト内の翻訳エラーを確認します。

## CLIを使うべき場面 [#when-to-use]

CLIは、次のような場合に使用します。

* ガイド付きウィザードで、翻訳用の新しいプロジェクトをセットアップする。
* ビルドやCIパイプラインの一部としてプロジェクトを翻訳する。
* フレームワークのライブラリを追加せずに、スタンドアロンのコンテンツファイルを翻訳する。
* 原文コンテンツと一緒に翻訳をバージョン管理で管理する。

## クイックスタート [#quickstart]

`gt` をインストールし、プロジェクトを設定して、最初の翻訳を実行しましょう。`package.json` があり、Node.js 20 以降がインストールされている既存のプロジェクトが必要です。

### 1. `gt` をインストールする

CLI を開発依存関係として追加します。

<Tabs items={['npm', 'yarn', 'bun', 'pnpm']}>
  <Tab value="npm">
    ```bash
    npm install gt --save-dev
    ```
  </Tab>

  <Tab value="yarn">
    ```bash
    yarn add --dev gt
    ```
  </Tab>

  <Tab value="bun">
    ```bash
    bun add --dev gt
    ```
  </Tab>

  <Tab value="pnpm">
    ```bash
    pnpm add --save-dev gt
    ```
  </Tab>
</Tabs>

### 2. プロジェクトを設定する

[`gt init`](/docs/cli/reference/commands/init) を実行すると、フレームワークを検出して `gt.config.json` を作成し、必要に応じてプロジェクトと開発用キーをセットアップします。サインインが必要なステップでは、ウィザードがサインインを案内します。

```bash
npx gt init
```

モノレポでは、ローカライズしたいアプリのディレクトリでコマンドを実行してください。ワークスペースのルートで実行すると、ウィザードはファイルを変更せずに終了します。

<Callout type="warn">
  ターミナルがない環境では、[`gt init`](/docs/cli/reference/commands/init) はプロンプトを表示しません。必要な回答が不足している場合は、ファイルを変更する前に停止し、指定すべきオプションを一覧表示します。詳しくは [ヘッドレス実行](/docs/cli/reference/commands/init#headless) を参照してください。CI では [CI 向けの非対話型セットアップ](#ci-setup) を使用してください。
</Callout>

ウィザードでは、デフォルトロケールとターゲットロケールを設定し、翻訳の保存先を選択します。開発用キーとプロジェクト ID を `.env.local` に書き込むこともできます。コマンドの詳細は [`gt init`](/docs/cli/reference/commands/init) を参照してください。

*メモ: この時点で、プロジェクトのルートに `gt.config.json` が作成されているはずです。ローカルにバンドルする Vite 構成では、サインインと認証情報の設定を省略できます。翻訳を始める前に、次のステップを完了してください。*

### 3. 認証情報を確認する

[`translate`](/docs/cli/reference/commands/translate) コマンドを実行するには、プロジェクト ID に加えて、保存済みのログイン情報または API キーが必要です。セットアップでこれらを設定しなかった場合は、[`gt login`](/docs/cli/reference/commands/login) を実行してから、プロジェクト ID を設定してください：

```bash title=".env.local"
GT_PROJECT_ID=your-project-id
```

 ([CLI の認証情報](/docs/cli/guides/configuring#credentials)を参照してください。)

### 4. プロジェクトを翻訳する

[`translate`](/docs/cli/reference/commands/translate) コマンドを実行すると、`gt.config.json` で設定されたすべてのファイルに加え、ソースコード内のインライン [`<T>`](/docs/react/reference/components/t) コンポーネントや辞書エントリも翻訳されます。

```bash
npx gt translate
```

翻訳はコードベースに保存され、すぐにコミットできます。本番用にビルドする前に、CI パイプラインでこれを実行してください。ワークフロー全体については、[翻訳を生成する](/docs/cli/guides/generating-translations)を参照してください。

## CI 向けの非対話型セットアップ [#ci-setup]

CI では、プロジェクトを手動で設定してください。`gt.config.json` をコミットし、認証情報を環境変数として指定して、その設定を使って [`translate`](/docs/cli/reference/commands/translate) を実行します。

### 1. `gt.config.json` を追加する

ファイルは自分で作成してコミットし、CLI が何を翻訳すべきか判断できるようにします。最小限の config では、source とターゲットロケールに加え、[`translate`](/docs/cli/reference/commands/translate) が処理する対象として `files` エントリを設定します。以下の `gt` エントリは、フレームワークの翻訳 (`gt-next`、`gt-react`、または `gt-react-native` 由来) を、指定された path にローカルで保存します。

```json title="gt.config.json"
{
  "$schema": "https://assets.gtx.dev/config-schema.json",
  "defaultLocale": "en",
  "locales": ["fr", "es"],
  "files": {
    "gt": {
      "output": "public/_gt/[locale].json"
    }
  }
}
```

代わりにスタンドアロンファイルを翻訳する場合は、`gt` エントリの代わりに、またはそれと併せて、`include` グロブ付きの `json` や `mdx` などのファイルタイプを追加します。ファイルとストレージのオプションについては [CLI の設定](/docs/cli/guides/configuring) を、各フィールドについては [設定リファレンス](/docs/cli/reference/config) を参照してください。

### 2. 認証情報を設定する

プロジェクトの API キーとプロジェクト ID は、コミットするファイルではなく、CI プロバイダーのシークレット設定で環境変数として設定してください。キーは [Dashboard](/docs/platform/dashboard/reference/api-keys) または [`gt api-key create`](/docs/cli/reference/commands/api-key-create) で作成し、**Files &gt; Write** と **Translation queue &gt; Enabled** の権限を付与してください (コンテキストを生成する場合は **Context &gt; Write** も追加します) 。ウィザードで作成される開発用キーでは権限が足りません。

```bash
GT_API_KEY=your-api-key
GT_PROJECT_ID=your-project-id
```

### 3. `translate` コマンドを実行する

本番環境向けに build する前に [`translate`](/docs/cli/reference/commands/translate) を実行します。config file を指定するには、`--config` を渡します。

```bash
npx gt translate --config gt.config.json
```

## Next steps

- /docs/cli/guides/generating-translations
- /docs/cli/guides/configuring
- /docs/cli/guides/managing-translations
- /docs/cli/guides/using-auto-jsx

## Sitemap

See the full [sitemap](https://generaltranslation.com/sitemap.md) for all pages.