# gt: General Translation CLI tool: クイックスタート
URL: https://generaltranslation.com/ja/docs/cli/quickstart.mdx
---

title: クイックスタート
description: General Translation CLI (`gt`) の機能、使いどころ、そして最初のプロジェクトをどう翻訳するかを学びます。
related:
  links:
    - /docs/cli/guides/generating-translations
    - /docs/cli/guides/configuring
    - /docs/cli/guides/managing-translations
    - /docs/cli/guides/using-auto-jsx

---

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 の構成要素**: 分離された pipeline の各 stage 間で、翻訳のアップロード、エンキュー、ダウンロードを行います。
* **検証**: API を呼び出さずに、プロジェクト内の翻訳エラーを確認します。

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

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

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

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

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

### 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.config.json` が作成されて、選択したセットアップで必要な場合は認証情報が生成されます。

```bash
npx gt init
```

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

<Callout type="warn">
  [`gt init`](/docs/cli/reference/commands/init) は対話型ウィザードであり、ターミナルが必要です。CI やその他の非対話シェルでは、入力待ちになったり、検証に失敗したり、`gt.config.json` を作成したり認証情報を書き込んだりしないまま早期終了したりする場合があります。そのような環境では、[CI 向けの非対話型セットアップ](#ci-setup) を使用してください。
</Callout>

ウィザードでは、デフォルトロケールとターゲットロケールを設定し、翻訳の保存先を選びます。選択したセットアップで認証情報が必要な場合は、API キー と プロジェクト ID を `.env.local` に書き込むことができます。詳しい設定方法については [CLI の設定](/docs/cli/guides/configuring) を、コマンドの詳細については [`gt init`](/docs/cli/reference/commands/init) を参照してください。

*注: この時点で、プロジェクトルートに `gt.config.json` があるはずです。ウィザードで認証情報が生成された場合、`.env.local` には `GT_API_KEY` と `GT_PROJECT_ID` が含まれます。ローカルにバンドルする Vite セットアップでは認証情報を省略するため、翻訳する前に次の手順で追加してください。*

### 3. 本番用の API キーを追加する

[`translate`](/docs/cli/reference/commands/translate) コマンドの実行には、本番用の API キーとプロジェクト ID が必要です。これらはウィザードで生成するか、[API キー ページ](https://generaltranslation.com/dashboard) で作成できます。CLI が参照できるよう、環境変数として設定してください。

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

*注: API キーは環境変数として設定し、`gt.config.json` には絶対に追加しないでください。*

### 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 プロバイダーのシークレット設定で環境変数として設定してください。これらは [API キー ページ](https://generaltranslation.com/dashboard) で作成できます。

```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