# gt: General Translation CLI tool: gt setup
URL: https://generaltranslation.com/zh/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 Key。   | `string`  | 是  | `GT_API_KEY`     |
| `--project-id <id>`   | 项目 ID。          | `string`  | 是  | `GT_PROJECT_ID`  |
| `-c, --config <path>` | 配置文件路径。         | `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) 向导中的 source 注册步骤运行。
* 注册 源文件 后，可使用 [`gt enqueue`](/docs/cli/reference/commands/enqueue) 将翻译加入队列，再通过 [`gt download`](/docs/cli/reference/commands/download) 下载；或者运行 [`gt translate`](/docs/cli/reference/commands/translate) 一步完成翻译。