Использование CLI (Strings)

Управляйте тем, как клиент перемещает и извлекает файлы, используя файл конфигурации .phrase.yml.

Образец файла конфигурации.

Правила экранирования и использование кавычек

При передаче объектов JSON в командной строке правила экранирования и использование кавычек могут варьироваться в зависимости от используемой оболочки.

Если используется оболочка Windows, заключите всю строку JSON в двойные кавычки """ и экранируйте двойные кавычки в JSON, используя символ обратной косой черты \. Например:

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

Доступ к конечным точкам API

Клиент может быть использован, чтобы получить доступ ко всем конечным точкам интерфейса приложений API. Например, для списка всех проектов:

$ phrase projects list --access_token ACCESS_TOKEN

Аутентификация с использованием учетных данных Phrase

Укажите имя пользователя, пометив его --username, и будет запрошен пароль:

$ phrase projects list --username user@example.com
Password: ********

Если для пользователя или организации активирована двухфакторная аутентификация, необходимо предоставить действительный многофакторный токен через пометку --tfa:

$ phrase projects list --username user@example.com --tfa
Password: ********
TFA: ********

аутентификация с использованием токен получить доступ Strings

Используйте пометку --access_token, чтобы указать свой токен доступа:

$ phrase projects list --access_token ACCESS_TOKEN

или используйте переменную среды PHRASE_ACCESS_TOKEN для хранения токена:

export PHRASE_ACCESS_TOKEN="ACCESS_TOKEN"

Если двухфакторная аутентификация активирована, необходимо указать действительный многофакторный токен через пометку --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, но поведение можно переопределить, используя упомянутые пометки или переменные env, и вместо него будет использован токен, предоставленный через пометку или переменную среды. Токены, предоставленные через пометки, переопределяют токены, предоставленные через переменную среды.

При хранении файла .phrase.yml в хранилище кода рекомендуется сначала удалить токен и использовать альтернативные методы, такие как передача токен через среду или флаг командной строки. Хранение секретных токен непосредственно в хранилище может быть вопрос безопасности.

аутентификация с использованием токен получить доступ Platform

Токен интерфейс приложений API Platform не принимаются напрямую через Strings CLI. Пользователи должны сначала обменять их на краткосрочный токен получить доступ к продукту (JWT), а затем использовать возвращенный токен одним из следующих способов:

Push и pull

Используйте команды push и pull, чтобы загрузить и скачать файлы языковых стандартов. Вместо аргументов командной строки push и pull полагается на конфигурацию, хранящуюся в файле конфигурации .phrase.yml в корневой папке проекта.

Если в push установлен параметр Update_translations, push перезаписывает переводы. Pull всегда перезаписывает переводы в локальном файле.

Чтобы автоматически удалить ключи в Phrase Strings при их удалении из файла оригинал, добавьте параметр delete_unmentioned_keys: true в раздел push файла конфигурации .phrase.yml. Этот параметр должен быть размещен на уровне push, на одном уровне с оригинал, а не вложен в params. Этот параметр удаляет любой ключ в проект Phrase, который отсутствует в синхронизированном файле. Использовать это только в том случае, если файл оригинал содержит все ключи для проект.

Пример конфигурации для загрузки и скачивания файлов языковых стандартов типичного приложения Rails:

phrase:
  access_token: "ACCESS_TOKEN"
  project_id: "PROJECT_ID"
  file_format: "yml"
  push:
    sources:
      - file: "./config/locales/<locale_name>.yml"
  pull:
    targets:
      - file: "./config/locales/<locale_name>.yml"

Используйте команду push, чтобы загрузить файлы языковых стандартов в проект, обозначенный project_ id как файл de.yml и en.yml в папке настройки/ языковых стандартов. Если появятся новые ключи, они будут добавлены в файл локализации:

$ phrase push
Uploading config/locales/de.yml
Uploaded config/locales/de.yml successfully.
Uploading config/locales/en.yml
Uploaded config/locales/en.yml successfully.

Используйте команду pull, чтобы скачать файлы языковых стандартов из проекта, обозначенного project_id, по их соответствующим путям файлов. Если появятся новые ключи, они будут добавлены в проект:

$ phrase pull
Downloaded de to config/locales/de.yml
Downloaded en to config/locales/en.yml

Поддержка лимита ставок

Клиент поддерживает лимит ставок для скачивания языковых стандартов. При достижении лимита ставки клиент ждет истечения лимита ставки и после этого продолжает скачивать языковые стандарты. Клиент показывает, что лимит ставки превышен, загрузка возобновится через х секунд.

Загрузить очистку

Команда очистки загрузок предназначена для удаления ключей, которые найдены в проекте, но не содержатся в загруженном файле. После отправки файлов языковых стандартов может потребоваться удаление всех ключей, которые не содержатся в языковом стандарте по умолчанию или каких-либо других языковых стандартах:

$ 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}’ \
--access token YOUR_ACCESS_TOKEN

Префикс ключ перевода

Префикс ключ перевода предотвращает конфликты ключ в разных проект или файлах и улучшает отслеживаемость ключ перевода. Интерфейс приложений API CLI поддерживает обработку префикса ключ как для операций pull, так и для push.

Пример конфигурации файла phrase.yml:

phrase:
  access_token: access_token
  file_format: yml
  push:
    sources:
      -
        file: path/to/your/file.yml
        project_id: project_id
        params:
          locale_id: en
          translation_key_prefix: prefix_
  pull:
    targets:
      -
        file: path/to/your/file.yml
        project_id: project_id
        params:
          translation_key_prefix: prefix_
          filter_by_prefix: true

Пример команд Curl:

curl "https://api.phrase.com/v2/projects/:project_id/uploads?translation_key_prefix=prefix_" \
  -u USERNAME_OR_ACCESS_TOKEN \\
  -X POST \\
  -F file=@/path/to/my/file.format \\
  -F file_format=format \
  -F locale_id=locale_id

curl \"https://api.phrase.com/v2/projects/:project_id/locales/:id/download?file_format=file_format&translation_key_prefix=prefix_&filter_by_prefix=true\" \\
  -u USERNAME_OR_ACCESS_TOKEN

Прокси

Если используется прокси-сервер, задайте настройки прокси, используя переменную среды HTTPS_PROXY:

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

Несколько файлов локализации для одного проекта

Используйте в проекте один файл на каждый языковой стандарт. Если инструменты или рамки вынуждают использовать несколько файлов, см. раздел «Поддержка файловых структур», чтобы узнать, как настроить проект.

Несколько проектов для одного проекта локализации

При работе над крупным проектом локализации распределите переводы по нескольким проектам. Настройка CLI для работы с несколькими файлами локализации для одного проекта локализации.

Параметры формата

Некоторые форматы файлов позволяют задавать параметры формата для усиления контроля над синтаксисом файлов. Укажите параметры формата в файле конфигурации .phrase.yml:

phrase:
  pull:
    targets:
    - file: file.xml
      params:
        format_options:
          convert_placeholder: true

  push:
    sources:
    - file: file.csv
      params:
        format_options:
          column_separator: ";"

Конфигурация для проектов на базе Android

Android не использует стандартные коды языка ISO в качестве шаблона файла. Укажите требуемый шаблон в .phrase.yml.

Вместо определения отдельного перевод для каждого языковой стандарт, использовать глобальный параметр locale_mapping в сочетании с заполнитель <locale_name>. CLI будет использовать Пользовательский имя из сопоставления для соответствующего языковой стандарт и возвращаться к коду языковой стандарт Phrase по умолчанию для всех остальных язык.

Например:

phrase:
  access_token: ACCESS_TOKEN
  project_id: PROJECT_ID
  file_format: "xml"

  # Сопоставить Phrase языковой стандарт с именами каталогов для Android
  locale_mapping:
    en-US: values
    de-DE: values-de-rDE
    fr-FR: values-fr

  push:
    sources:
      # оригинал файл — это язык по умолчанию, сопоставленный с 'values'
      - file: ./app/src/main/res/values/strings.xml
        params:
          Идентификатор языковой стандарт: en-US # Должен иметь совпадение с оригинал языковой стандарт в Phrase

  pull:
    targets:
      # использовать заполнитель <locale_name>, который будет заменен сопоставлением
      - file: ./app/src/main/res/<locale_name>/Strings.xml