CLI設定ファイル（Strings）の作成

本コンテンツはPhrase Language AIの機械翻訳により、英語から翻訳されています。

前提条件

APIアクセス・トークンを読み書きスコープで
プロジェクト設定のAPIタブに表示されるStringsプロジェクトID
インデントを含む基本的なYAMLの知識
CIでphrase pushまたはphrase pullを実行する場合、リポジトリに対するGitの読み書き権限

設定ファイルを自動的に作成するには、次の手順に従ってください：

コマンドラインからphrase initと入力して.phrase.ymlファイルを作成します。

設定ウィザードがCLIで開始されます。
提供：
- アクセス・トークン
  
  貼り付けるか、Enterを押して$PHRASE_ACCESS_TOKENを使用できるようにします。
- StringsプロジェクトID（例：abcdef1234567890abcdef1234567890）
- ロケールファイル形式（例：json、rails_yaml、ios_strings）
- ローカルパス
  
  プロジェクトコードベース内のロケールファイルへのグロブまたは正確なパス（例：config/locales/*.json）

基本的な.phrase.ymlファイルが現在のディレクトリに作成されます。

ヒント

ウィザードを完全にスキップするためのフラグを提供します。例えば、phrase init --access_token=$PHRASE_ACCESS_TOKEN --project_id=... --file_format=ios_strings --path='ios/*.strings'。

手動で作成またはコピーした設定ファイルを使用する場合は、次のいずれかの場所に配置します：

CLI クライアントが呼び出される現在の作業ディレクトリ (pwd)。
現在のユーザーのホームディレクトリ（Unix の場合は $HOME、Windows の場合は $HomePath）。
PHRASEAPP_CONFIG 環境変数で指定されたパス。
--config フラグ経由の設定ファイルのパス（例：/some/path/to/phrase.yml）。

CLI オプションの概要

設定ファイルのサンプル。

グローバル設定

キー	タイプ	必須	項目
`phrase.access_token`	文字列	はい	個人用アクセストークン。
`phrase.project_id`	文字列	はい	Strings プロジェクト設定に表示される公開プロジェクト ID。
`phrase.file_format`	文字列	はい	デフォルトのロケールファイル形式 (API 拡張)。
`phrase.locale_mapping`	オブジェクト	いいえ	Phrase のロケール ID をカスタム名にマッピングし、`<locale_name>` プレースホルダーを使用してファイルパスで使用します。これは、Android のような非標準の命名規則を持つプラットフォームに役立ちます。マッピングにロケールが指定されていない場合、標準のPhraseロケール名がデフォルトで使用されます。

プッシュ: ソース

キー	タイプ	必須	項目
`push.sources[].file`	パス	はい	プッシュするファイルへの相対パス、例: `./path/to/file/<locale_code>.json`。`<locale_name>`、`<locale_code>`、`<tags>`をサポートします。
`push.sources[].project_id`	文字列		この特定のファイルソースに対してグローバル`project_id`を上書きします。同じ設定ファイルから複数のPhraseプロジェクトにファイルをプッシュする際に便利です。

プッシュ: パラメータ

パラメータ	タイプ	デフォルト	項目
`file_format`	文字列	ヘッダー	このソースのファイル形式を上書きします。
`locale_id`	文字列	—	ロケール名（例: `en-US`）または公開ロケールID。
`tags`	文字列	—	新しいキーのためのカンマ区切りのタグ。
`update_translations`	ブール	`false`	ファイルの内容で既存の翻訳を更新します。
`update_translation_keys`	ブール	`true`	ここに`false`を渡すと、新しいキーの作成と既存のキーの更新を防ぎます。
`update_descriptions`	ブール	`false`	キーの説明を更新します; 空の説明は既存のものを上書きします。
`skip_upload_tags`	ブール	`false`	アップロードタグは作成されません。
`skip_unverification`	ブール	`false`	更新された翻訳は未検証ではありません。
`file_encoding`	文字列	—	ファイルエンコーディング: `UTF-8`, `UTF-16`, `UTF-16BE`, `UTF-16LE`, または `ISO-8859-1`。
`locale_mapping`	オブジェクト	—	（Excel/CSVのみ）ロケールコードを列名にマッピングします。例: `{"en": "C", "de": "D"}` 翻訳を解析するため。これは、ファイルパスに使用されるトップレベルの`locale_mapping`とは異なります。
`autotranslate`	ブール	`false`	アップロードされた言語の翻訳を自動取得します。
`mark_reviewed`	ブール	`false`	インポートされた翻訳をレビュー済みとしてマークします（高度なレビューワークフローを有効にする必要があります）。

プッシュ: ファイル形式オプション

CLI構成で利用可能なすべてのファイル形式オプションがサポートされています。例についてはサンプル構成ファイルを参照してください。

プル: ターゲット

キー	タイプ	必須	項目
`pull.targets[].file`	パス	はい	プルされたロケールファイルの相対パス。例: `./Radio.de/<locale_code>.lproj/Localizable.strings`。
`pull.targets[].project_id`	文字列		この特定のプルターゲットのために、グローバル`project_id`を上書きします。同じ構成ファイルを使用して、複数のPhraseプロジェクトから翻訳をプルすることを有効にします。

プル: パラメータ

パラメータ	タイプ	デフォルト	項目
`file_format`	文字列	—	`strings`である必要があります。
`locale_id`	文字列	—	ロケール名（例: `en-US`）または公開ロケールID。
`tags`	文字列	—	プルするキーをフィルタリングするためのカンマ区切りのタグ。
`include_empty_translations`	ブール	`false`	翻訳がないキーを含めます。
`exclude_empty_zero_forms`	ブール	`false`	空のときはゼロ形の複数形を除外します。
`include_translated_keys`	ブール	`true`	すでに翻訳があるキーを含めます。
`keep_notranslate_tags`	ブール	`false`	出力に `[NOTRANSLATE]` タグを保持します。
`encoding`	文字列	—	ファイルエンコーディング: `UTF-8`, `UTF-16`, `UTF-16BE`, `UTF-16LE`, または `ISO-8859-1`。
`include_unverified_translations`	ブール	`true`	`false` の場合、未検証の翻訳を除外します。
`use_last_reviewed_version`	ブール	`false`	`true` の場合、最後にレビューされたバージョンを使用します（高度なレビューワークフローが必要です）。
`fallback_locale_id`	文字列	—	欠落している翻訳に使用するフォールバックロケール。

プル: ファイル形式オプション

CLI構成で利用可能なすべてのファイル形式オプションがサポートされています。例についてはサンプル構成ファイルを参照してください。

複数の設定

モノレポでは、各パッケージに1つの設定ファイルを配置し、対応するサブフォルダからCLIを実行するか、CIジョブを --config オプションを使用して異なる設定ファイルにポイントします。

Git統合

GitLab:

.phrase.yml 設定ファイルがリポジトリ内に存在する必要があります。ファイルは、リポジトリからインポート（pull）またはエクスポート（push）するファイルを定義します。
リポジトリには読み取りおよび書き込みアクセスが必要です。
設定ファイルの定義が正しくない場合、エラーが発生する可能性があります。ファイルに少なくとも1つのpushと1つのpull訳文、正しいファイル形式、およびupdate_translationsパラメータの設定があることを確認してください。
API 互換性を確保するには、GitLab 9.5 以降を使用してください。

GitHub:

.phrase.yml 設定ファイルがリポジトリ内に存在する必要があります。ファイルは、リポジトリからインポート（pull）またはエクスポート（push）するファイルを定義します。
リポジトリには読み取りおよび書き込みアクセスが必要です。
設定ファイルの定義が正しくない場合、エラーが発生する可能性があります。ファイルに少なくとも1つのpushと1つのpull訳文、正しいファイル形式、およびupdate_translationsパラメータの設定があることを確認してください。
リポジトリスコープの GitHub アクセストークン (パブリックリポジトリと同期する場合は public_repo)。
GitHub で SSO が有効になっている場合は、アクセストークンも有効にする必要があります。
phrase_translations ブランチは保護できません。
リポジトリ設定で署名付きコミットが不要であることを確認してください。

BitBucket:

.phrase.yml 設定ファイルがリポジトリ内に存在する必要があります。ファイルは、リポジトリからインポート（pull）またはエクスポート（push）するファイルを定義します。
リポジトリには読み取りおよび書き込みアクセスが必要です。
設定ファイルの定義が正しくない場合、エラーが発生する可能性があります。ファイルに少なくとも1つのpushと1つのpull訳文、正しいファイル形式、およびupdate_translationsパラメータの設定があることを確認してください。

phrase_configuration_overview.yml
(8 KB)