# gt: General Translation CLI tool: gt init
URL: https://generaltranslation.com/zh/docs/cli/reference/commands/init.mdx
Docs index: https://generaltranslation.com/llms.txt
Description: 运行 General Translation 的设置向导来配置项目。gt init 命令的 API 参考。

`init` 是默认命令——直接运行 `npx gt` (不带任何命令) 时，会执行它。

该向导会检测你的框架，并根据项目情况安装依赖、配置框架、创建 `gt.config.json`，以及生成凭据。有关详细步骤，请参阅[配置 CLI](/docs/cli/guides/configuring)。

```bash
npx gt init
```

## 工作方式 [#how-it-works]

1. 检测你的框架。对于 Next.js App Router 或 Mintlify 项目，它会改为提示你连接 [Locadex](/docs/platform/locadex/quickstart) AI 智能体。
2. 对于基于 React 的项目，可选择安装 `gt-react` 或 `gt-next`，并配置框架 (实验性) 。Vite 应用会添加一个在现有应用入口之前运行的 [`initializeGTSPA`](/docs/react/reference/config#initialize-spa) 引导程序；其他受支持的 React 应用则使用 [`GTProvider`](/docs/react/reference/components/gt-provider)。
3. 提示你输入缺失的默认区域设置和目标区域设置，并创建或更新 `gt.config.json`。现有的区域设置和文件设置会被保留。对于本地 Vite 存储，还会创建一个 [`loadTranslations`](/docs/react/reference/functions/load-translations) 文件和空的目标区域设置文件。
4. 当配置的工作流需要持久安装 CLI 时，将 `gt` 安装为开发依赖。Vite 框架设置不会添加 `gt`；请继续使用 `npx gt` 运行它。
5. 可选择生成 API 密钥和项目 ID，并将其写入 `.env.local`。

*注意：React 设置步骤仍处于实验阶段，可能不适用于所有项目。请检查它所做的更改。*

## 标志 [#flags]

| 参数                    | 描述               | 类型         | 可选 | 默认值                                        |
| --------------------- | ---------------- | ---------- | -- | ------------------------------------------ |
| `--src <paths...>`    | 应用源码的 Glob 模式。   | `string[]` | 是  | `src`、`app`、`pages`、`components` 的 glob 模式 |
| `-c, --config <path>` | config file 的路径。 | `string`   | 是  | `gt.config.json`                           |

## 示例 [#example]

```bash
# 运行完整的设置向导
npx gt init

# 不带任何命令运行 gt 效果相同
npx gt
```

## 其他说明 [#notes]

* `init` 会执行与 [`gt configure`](/docs/cli/reference/commands/configure) 和 [`gt auth`](/docs/cli/reference/commands/auth) 相同的步骤，另外还会运行实验性的 React 设置向导。若只想重做其中某一步，请单独运行对应命令。它不会运行 [`gt setup`](/docs/cli/reference/commands/setup)，该命令会上传你的源文件。
* 在 monorepo 中，请从具体的应用目录运行 `init`。当当前目录是包含 `pnpm-workspace.yaml` 或 `workspaces` 字段的 workspace 根目录时，该命令会停止执行，且不会更改文件。
* Electron 应用程序不支持自动设置。
* 使用 `gt-react` 或 `gt-next` 不需要 API 密钥和项目 ID——只有在调用 General Translation API 时才需要它们。
* 如果实验性的 React 设置不适用于你的项目，请参照 [React](/docs/react/react-quickstart) 文档手动进行设置。

## Sitemap

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