# gt: General Translation CLI tool: 暂存翻译
URL: https://generaltranslation.com/zh/docs/cli/stage.mdx
---
title: 暂存翻译
description: 如何将翻译暂存以供审核
---

## 概述

`gt stage` 是一条命令，用于为你的项目生成翻译，并将其暂存以供审核。

只有在项目中启用了人工审核时，此命令才有意义。

## 用法

<Callout type="error">
  请在 CI 流水线中于生产环境构建应用**之前**运行此命令。
</Callout>

```bash
npx gt stage
```

<Callout type="info">
  **注意：**
  此命令需要生产环境 API 密钥！可在[平台](https://generaltranslation.com/dashboard)获取。
</Callout>

`gt stage` 命令的工作方式与 `translate` 命令相同，但它不会下载已完成的翻译或将其发布到 CDN，而是将其暂存以供审核。

运行 `gt stage` 后，你应再运行 `gt translate`，以完成整个流程并下载翻译 (如果已配置为下载) 。

<Callout type="warn">
  **仅限生产环境使用！**

  此命令用于生产构建，**不应在开发环境中使用**。
  运行此命令前，请务必确认你当前所在的分支将用于生产环境。
  还请记得在环境变量中指定生产环境 API 密钥 (`GT_API_KEY`) 和项目 ID (`GT_PROJECT_ID`) 。
</Callout>

***


## 标志

| Parameter                       | Description                         | Type       | Optional | Default                                                                                                                         |
| ------------------------------- | ----------------------------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `--api-key`                     | 指定生产环境 API 密钥                       | `string`   | `true`   |                                                                                                                                 |
| `--project-id`                  | 指定项目 ID                             | `string`   | `true`   |                                                                                                                                 |
| `--version-id`                  | 指定版本 ID (默认是内容的哈希值)                 | `string`   | `true`   |                                                                                                                                 |
| `--config <path>`               | 指定 GT 配置文件路径                        | `string`   | `true`   | `"gt.config.json"`                                                                                                              |
| `--tsconfig, --jsconfig <path>` | 指定 TS 或 JS 配置文件路径                   | `string`   | `true`   |                                                                                                                                 |
| `--src <paths>`                 | 用空格分隔的 glob 模式列表，用于匹配源文件。路径应相对于根目录。 | `[string]` | `true`   | `[  'src/**/*.{js,jsx,ts,tsx}', 'app/**/*.{js,jsx,ts,tsx}', 'pages/**/*.{js,jsx,ts,tsx}', 'components/**/*.{js,jsx,ts,tsx}', ]` |
| `--dictionary <path>`           | 指定字典文件路径                            | `string`   | `true`   |                                                                                                                                 |
| `--inline`                      | 除字典外，还包含内联 `<T>` 标签                 | `boolean`  | `true`   | `true`                                                                                                                          |
| `--timeout`                     | 翻译请求的超时时间 (秒)                       | `number`   | `true`   | `900`                                                                                                                           |
| `--new, --locales <locales>`    | 要将项目翻译到的目标区域设置                      | `[string]` | `true`   |                                                                                                                                 |
| `--default-locale <locale>`     | 项目的源区域设置                            | `string`   | `true`   | `en`                                                                                                                            |
| `--ignore-errors`               | 忽略错误，并强制翻译有效内容                      | `flag`     | `true`   | `false`                                                                                                                         |
| `--tag [value]`                 | 为此次翻译运行添加标签 (如果未提供值，则自动从 git 解析)    | `string`   | `true`   |                                                                                                                                 |
| `-m, --message <message>`       | 附加到翻译标签的消息                          | `string`   | `true`   |                                                                                                                                 |
| `--dry-run`                     | 试运行该命令                              | `flag`     | `true`   | `false`                                                                                                                         |

以上所有参数均为可选。

<Callout type="warn">
  不要将 API 密钥添加到 `gt.config.json` 文件中！
  你应该将其改为设置为环境变量。CLI 会在设置了 `GT_API_KEY` 时自动读取它。
</Callout>

其中有几个关键参数：

| Parameter                    | Description                                                |
| ---------------------------- | ---------------------------------------------------------- |
| `--dry-run`                  | 此标志会让 CLI 解析并验证你的项目，但不会与 GT API 通信。这可用于验证你的代码库。            |
| `--api-key`                  | 除非你使用 `--dry-run`，否则必须提供生产环境 API 密钥。                       |
| `--project-id`               | 同样，除非你使用 `--dry-run`，否则必须提供项目 ID。                          |
| `--new, --locales <locales>` | 要将项目翻译到的目标区域设置。这些区域设置会追加到 `gt.config.json` 文件中指定的 locales。 |

### 配置文件

运行 `gt stage` 时，CLI 会自动在 `gt.config.json` 文件中添加 `stageTranslations : true` 属性。

该属性可确保：如果在针对某个特定部署版本运行 `translate` 之前未先运行 `stage``，CLI 工具就会报错并退出。