> ## Documentation Index
> Fetch the complete documentation index at: https://hyperlocalise.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# 同步拉取

> 将已完成的 Hyperlocalise 作业输出拉取到本地文件。

<Note>
  公共 jobs API 合同可能会在 CI 工作流稳定的同时演进。
</Note>

## 用法

```bash theme={null}
hyperlocalise sync pull [--config <path>] [flags]
```

## 默认行为

`sync pull` 默认会应用已完成的作业输出。若要在不写入文件的情况下预览报告，请使用 `--dry-run`。

`sync pull` 读取完整的作业清单，按作业 ID 轮询公共 Hyperlocalise API，直到每个待处理作业完成或配置的超时到期，下载成功的输出文件，并将它们写入由 `i18n.yml` 解析出的目标路径。

清单通常会从一个 `sync push` GitHub Actions 作业传递到一个 `sync pull` 作业，使用 `actions/upload-artifact` 和 `actions/download-artifact`。

## 标志

* `--config`: 配置路径
* `--locale`：目标语言环境，可重复
* `--manifest`：作业清单路径
* `--timeout`：最大等待时间，例如 `20m`
* `--dry-run`：仅预览
* `--output`：`text`、`json`或`markdown`

## 示例

```bash theme={null}
hyperlocalise sync pull --manifest .hyperlocalise/jobs.json --timeout 20m
```

```bash theme={null}
hl pull --manifest .hyperlocalise/jobs.json
```

## 备注

* `sync pull` 拒绝包含 `complete: false` 的清单。
* 超时错误在可用时包括待处理的作业 ID、源路径、目标语言环境和状态。
* 输出文件会按语言区域映射到清单中捕获的目标路径。
* 特定于提供商的 TMS 命令，例如 `crowdin` 和 `phrase`，保留各自的配置和行为。

## 另请参见

* [run](/commands/run)
* [状态](/commands/status)
* [sync push](/commands/sync-push)
* [CI 自动化](/workflows/ci-automation)