# gt: General Translation CLI tool: 设置向导
URL: https://generaltranslation.com/zh/docs/cli/init.mdx
---
title: 设置向导
description: 运行 GT 设置向导
---

## 用法

```bash
npx gt init
```

使用此命令启动 GT 设置向导。

此命令等同于先运行 `setup`，再运行 `configure`。

该向导将会：

1. 为你的项目安装必要的依赖项。
2.  (如果是 Next.js) 将 `withGTConfig` 函数添加到你的 `next.config.js` 文件中，并完成 `GTProvider` 组件的设置。
3. 在项目根目录创建 `gt.config.json` 文件。
4. 为你的项目生成 API 密钥和项目 ID。


## 依赖项

`init` 命令会为你的项目安装以下依赖：

* `gt-react` 或 `gt-next` (如果你的项目基于 React) 
* `gt` (如果尚未安装，则会作为开发依赖安装)

## 基于 React 的项目

如果你的项目基于 React，向导会帮助你将项目配置为使用 `gt-react` 或 `gt-next`。

如果你已经在使用其他 i18n 库，则可能需要手动配置项目。

更多信息请参阅 [React 文档](/docs/react) 或 [Next.js 文档](/docs/next)。

由于该向导目前仍处于实验阶段，因此可能无法适用于所有基于 React 的项目。
在这种情况下，你可能需要手动配置项目。

如果你遇到任何问题，请通过 [GitHub](https://github.com/generaltranslation/gt/issues) 告诉我们。

向导的这一部分也可以通过 `npx gt setup` 单独运行。

## `gt.config.json`

`init` 命令可帮助你配置项目的 GT 设置。

它会在项目根目录下创建一个 `gt.config.json` 文件。

该文件包含以下设置：

* `defaultLocale`：项目的默认区域设置。
* `locales`：项目[支持的区域设置](/docs/platform/supported-locales)数组。
* `files`：这是一个对象，包含你想要翻译的内容信息。

如需了解 `gt.config.json` 文件的更多详细信息，请参阅[配置文档](/docs/cli/reference/config)。

你也可以通过 `npx gt configure` 单独运行向导的这一部分。

## 凭据

该向导会帮助你为项目生成 API 密钥和项目 ID (如果尚未设置) 。

请注意，使用 `gt-react` 或 `gt-next` 不需要 API 密钥和项目 ID。

向导会将 API 密钥和项目 ID 添加到你的 `.env.local` 文件中。
如果该文件不存在，向导会创建它，并将 `.env.local` 添加到你的 `.gitignore` 文件中。

向导的这一部分也可以通过 `npx gt auth` 单独运行。