# gt: General Translation CLI tool: gt setup
URL: https://generaltranslation.com/ja/docs/cli/reference/commands/setup.mdx
---

title: gt setup
description: ソースファイルをアップロードし、General Translation のプロジェクトを登録します。`gt setup` コマンドの API リファレンス。

---

ソースファイルをアップロードして翻訳用にプロジェクトをセットアップしますが、結果はダウンロードしません。翻訳が始まる前に [`gt translate`](/docs/cli/reference/commands/translate) が実行するファイル収集とアップロードと同じステップを実行します。

ソースコンテンツを独立したステップとしてプラットフォームに登録したい場合は、`setup` を使用します。たとえば、分割された CI パイプラインの開始時です。これには、本番用の API キーとプロジェクト ID が必要です。

*注: `setup` はベース (フレームワーク非依存) のプロジェクトと React 系フレームワーク (`gt-react`、`gt-next`、`gt-react-native`、`gt-tanstack-start`) で利用できます。`gt-node` または Python プロジェクトでは利用できません。*

```bash
npx gt setup
```

## 仕組み [#how-it-works]

1. `gt.config.json` を読み取り、収集対象のソースファイルを特定します。
2. 翻訳前に [`gt translate`](/docs/cli/reference/commands/translate) が行うのと同じように、翻訳対象のソースファイルを収集してハッシュ化します。
3. 新規または変更されたソースファイルをアップロードし、プラットフォームにプロジェクトを登録します。
4. 翻訳をキューに追加したり、結果をダウンロードしたりせずに終了します。

## フラグ [#flags]

`setup` コマンドでは [`gt translate`](/docs/cli/reference/commands/translate#flags) と同じフラグを使用できます。以下に、特によく使われるものを示します。完全な一覧は、上記リンク先のリファレンスを参照してください。

| パラメータ                 | 説明                            | 型         | 任意 | デフォルト            |
| --------------------- | ----------------------------- | --------- | -- | ---------------- |
| `--api-key <key>`     | 本番用の API キー。                  | `string`  | はい | `GT_API_KEY`     |
| `--project-id <id>`   | プロジェクト ID。                    | `string`  | はい | `GT_PROJECT_ID`  |
| `-c, --config <path>` | config file へのパス。             | `string`  | はい | `gt.config.json` |
| `--dry-run`           | ファイルを収集し、アップロードせずにその内容を報告します。 | `boolean` | はい | `false`          |

## 例 [#example]

```bash
# ソースファイルをプラットフォームにアップロードして登録する
npx gt setup

# 実際にアップロードせず、アップロード対象のファイルを表示する
npx gt setup --dry-run
```

## その他の注意事項 [#notes]

* `setup` は、[`gt init`](/docs/cli/reference/commands/init) ウィザードのソース登録ステップとしても実行されます。
* ソースファイルを登録した後は、[`gt enqueue`](/docs/cli/reference/commands/enqueue) と [`gt download`](/docs/cli/reference/commands/download) で翻訳をキューに追加してダウンロードするか、[`gt translate`](/docs/cli/reference/commands/translate) を実行して 1 ステップで翻訳できます。