# gt: General Translation CLI tool: YAML
URL: https://generaltranslation.com/ja/docs/cli/reference/formats/yaml-files.mdx
---

title: YAML
description: General Translation CLI で YAML ファイルを翻訳します。YAML ファイル形式の API リファレンスです。

---

CLI では、使用している i18n ライブラリに関係なく YAML ファイルを翻訳できます。`.yaml` と `.yml` の両方の拡張子に対応しており、翻訳後も元の文字列構文が保持されます。

*注: ICU メッセージなどのカスタム文字列構文や書式設定は、`next-intl` と `i18next` でサポートされています。その他のライブラリでは、カスタム構文を含む文字列の翻訳精度が低くなる場合があります。*

## 設定 [#config]

`files` の下に、グロブパターンの `include` 配列を持つ `yaml` エントリを追加します。CLI がソースファイルを見つけて翻訳を正しいパスに保存できるよう、`[locale]` プレースホルダーを使用します。

```json title="gt.config.json"
{
  "defaultLocale": "en",
  "locales": ["zh", "es", "ja"],
  "files": {
    "yaml": {
      "include": ["i18n/[locale]/*.yaml"]
    }
  }
}
```

すべてのファイルキーについては、[設定リファレンス](/docs/cli/reference/config#files)を参照してください。

## キーごとのメタデータ [#metadata]

ソースと同じ構造の対応する `.metadata.yaml` ファイルを使って、キーごとの翻訳指示を追加できます。

```yaml title="translations.metadata.yaml"
nav:
  bank:
    context: "Riverbank — the side of a river. NOT a financial institution."
  save:
    context: "Sports term — a goalkeeper preventing a goal. NOT saving data."
    maxChars: 12
```

サポートされているすべてのフィールドについては、[keyed metadata リファレンス](/docs/cli/reference/keyed-metadata)を参照してください。