CLI

CLI の使用(Strings)

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

Phrase Strings CLIツールは、APIをナビゲートし、curlリクエストからではなくコマンドラインから迅速にプロジェクトと翻訳を管理するのに役立ちます。

米国データセンターを使用する場合は、phrase init --host https://api.us.app.phrase.com/v2-でホストを渡します。設定がすでに生成されている場合は、次のコードを追加します。

フレーズ:
  host: https://api.us.app.phrase.com/v2

基本的な使用方法

.phrase.yml 設定ファイルを編集することで、クライアントのファイルのプッシュおよびプル方法を制御します。

  1. プロジェクトを初期化する。

     phrase initを実行してプロジェクトを初期化します。これにより、推奨される ロケール ファイル形式や原文ファイルなどが定義されます。

    $ phrase init
  2. ロケールファイルをアップロードします。

    push サブコマンドを使用してロケールファイルをアップロードします。

    $ phrase push
  3. ロケールファイルをダウンロードします。

    プロジェクトに最新のロケールファイルをダウンロードするには、pull サブコマンドを使用します。

    $ phrase pull
  4. サブコマンドを追加。

    使用可能なすべてのサブコマンドのリストを表示するには、サブコマンドを指定せずに phraseを実行します。特定のサブコマンドでサポートされているすべてのオプションを表示するには、 --help フラグを使用します。

    $ phrase locales list --help

サンプルの設定ファイル

エスカレーションルールと見積もりの使用

コマンドラインで JSON オブジェクトを渡す場合、エスケープ規則と引用符の使用は使用するシェルによって異なることがあります。

Windows シェルを使用する場合は、JSON 文字列全体を二重引用符「」で囲み、JSON 内の二重引用符はバックスラッシュ \ 文字でエスケープします。以下に例を挙げます。

phrase locales create --project_id PROJECT123 --data "{\"name\":\"French\", \"code\":\"fr\"}" --access_token123123

アクセスと認証

APIエンドポイントへのアクセス

クライアントは、すべての API エンドポイントへのアクセスに使用できます。たとえば、すべてのプロジェクトをリストするには:

$ phrase projects list --access_token ACCESS_TOKEN

Phrase認証情報を使用した認証

--ユーザー名フラグでユーザー名を指定すると、パスワードが要求されます。

$ phrase projects list --username user@example.com
パスワード:********

ユーザーまたは組織に対して2段階認証がアクティブ化されている場合、有効な多要素トークンを--tfaフラグで指定する必要があります。

$ phrase projects list --username user@example.com --tfa
パスワード:********
TFA: ********

アクセストークンを使用した認証

環境変数の設定は、プラットフォームによって異なります。アクセストークンは.phrase.yml設定ファイルに格納することを推奨します。

--access_tokenフラグを使用してアクセストークンを指定します。

$ phrase projects list --access_token ACCESS_TOKEN

または、PHRASE_ACCESS_TOKEN環境変数を使用してトークンを保存します。

export PHRASE_ACCESS_TOKEN="ACCESS_TOKEN"

2段階認証がアクティブ化されている場合、有効な多要素トークンを--x_phrase_app_otpフラグで指定する必要があります。

$ phrase projects list --access_token ACCESS_TOKEN --x_phrase_app_otp PASSWORD

トークンは、--tfaフラグを使用してインタラクティブ モードで提供することもできます。

$ phrase projects list --access_token ACCESS_TOKEN --tfa
TFA: ********

アクセストークンはデフォルトで.phrase.yml設定ファイルから読み取られますが、前述のフラグまたは環境変数を使用することで動作を上書きでき、代わりにフラグまたは環境変数経由で提供されたトークンが使用されます。フラグ経由で提供されたトークンは、環境変数経由で提供されたトークンをオーバーライドします。

押して引く

push コマンドと pull コマンドを使用して、ロケール ファイルをアップロードおよびダウンロードします。コマンドライン引数の代わりに、push と pull はプロジェクトのルートフォルダにある .phrase.yml 設定ファイルに保存されている設定に依存します。

一般的なRailsアプリケーションのロケールファイルをアップロードおよびダウンロードするための設定例:

フレーズ:
  access_token:"ACCESS_TOKEN"
  project_id:"PROJECT_ID"
  file_format: "yml"
  push:
    原文:
      - file: "./config/locales/<locale_name>.yml"
  pull:
    targets:
      - file: "./config/locales/<locale_name>.yml"

push コマンドを使用して、config/localesフォルダ内のde.ymlおよびen.ymlファイルと一致するproject_idで識別されるプロジェクトにロケールファイルをアップロードします。

$ phrase push
config/locales/de.ymlをアップロードしています
config/locales/de.yml をアップロードしました。
config/locales/en.ymlをアップロードしています
config/locales/en.yml をアップロードしました。

pull コマンドを使用して、project_idで識別されるプロジェクトからそれぞれのファイルパスにロケールファイルをダウンロードします。

$ phrase pull
deをconfig/locales/de.ymlにダウンロードしました
enをconfig/locales/en.ymlにダウンロードしました

レート制限のサポート

クライアントはロケールダウンロードのレート制限をサポートしています。レート制限に達すると、クライアントはレート制限が切れるまで待機し、その後ロケールのダウンロードを続行します。クライアントにレート制限超過と表示されます。ダウンロードは x 秒後に再開されます。

クリーンアップをアップロード

プロジェクト内で検出されたが、アップロードされたファイルに含まれていないキーを削除するために、 uploads cleanup コマンドが用意されています。ロケールファイルをプッシュした後、デフォルトのロケールやその他のロケールに含まれていないキーをすべて削除する必要がある場合があります。

$ phrase uploads cleanup --id <YOUR_UPLOAD_ID>

フォーマットオプション

CSVなど一部のファイル形式は、アップロード中に追加のファイル形式オプションを使用できます。オプションの先頭に --format_options を付けて、これらのオプションにアクセスします。

phrase uploads create \
--project_id PROJECT_ID \
--file ./en.csv \
--file_format csv \
--locale_mapping ‘{“en”:3, “de”:2}’ \
--format_options ‘{“key_index”:1}’ \
--アクセストークン YOUR_ACCESS_TOKEN

プロキシ

プロキシを使用している場合は、HTTPS_PROXY 環境変数を使用してプロキシ設定を指定します。

export HTTPS_PROXY=https://user:password@host:port

複雑な使用

1つのプロジェクトに複数のローカライゼーションファイル

プロジェクトのロケールごとに1つのファイルを使用します。ツールまたはフレームワークによって複数のファイルの使用が強制される場合は、プロジェクトの設定方法の詳細について、 ファイル構造の維持 を参照してください。

1つのローカライゼーションプロジェクトに複数のプロジェクト

大規模なローカライゼーションプロジェクトに取り組む場合、翻訳を複数のプロジェクトに分散させます。複数のローカライゼーション ファイルを扱うように CLI を設定します。

フォーマットオプション

一部のファイル形式では、ファイル形式オプションを指定することでファイル構文をより詳細に制御できます。.phrase.yml設定ファイルでファイル形式オプションを指定してください::

フレーズ:
  pull:
    targets:
    - file: file.xml
      パラメータ:
        format_options:
          convert_placeholder: true

  push:
    原文:
    - file: file.csv
      パラメータ:
        format_options:
          column_separator: ";"

Android プロジェクト用の設定

Android では、ファイルのパターンとして標準の ISO 言語コードが使用されません。.phrase.yml で必要なパターンを指定します。

.phrase.ymlファイルで各ロケールを明示的に指定します。次の例は、英語をデフォルト言語とし、ドイツ語ロケールをドイツ語、およびオーストリアドイツ語をドイツ語地域ロケールとする .phrase.yml の設定を示しています。

フレーズ:
  access_token:ACCESS_TOKEN
  project_id:PROJECT_ID
  file_format: xml
  pull:
    targets:
    - file: ./app/src/main/res/values/strings.xml
      パラメータ:
        file_format: xml
        # 英語用の一意のロケールID
        locale_id:LOCALE_ID
    - file: ./app/src/main/res/values-de/strings.xml
      パラメータ:
        file_format: xml
        # ドイツ語用の一意のロケールID
        locale_id:LOCALE_ID
    - file: ./app/src/main/res/values-de-rAU/strings.xml
      パラメータ:
        file_format: xml
        # オーストリア語の一意のロケールID
        locale_id:LOCALE_ID
  push:
    原文:
    - file: ./app/src/main/res/values/strings.xml
      パラメータ:
        file_format: xml
        locale_id:LOCALE_ID
    - file: ./app/src/main/res/values-de/strings.xml
      パラメータ:
        file_format: xml
        locale_id:LOCALE_ID
    - file: ./app/src/main/res/values-de-rAU/strings.xml
      パラメータ:
        file_format: xml
        locale_id:LOCALE_ID
この記事は役に立ちましたか?

Sorry about that! In what way was it not helpful?

The article didn’t address my problem.
I couldn’t understand the article.
The feature doesn’t do what I need.
Other reason.

Note that feedback is provided anonymously so we aren't able to reply to questions.
If you'd like to ask a question, submit a request to our Support team.
Thank you for your feedback.