Phrase adapter - Hyperlocalise

Two Phrase workflows

Hyperlocalise supports two Phrase integrations:

Native sync mode with i18n.yml plus sync push / sync pull
Phrase-compatible file mode with .phrase.yml plus hyperlocalise phrase ...

Use native sync mode when you want Hyperlocalise-managed entry sync. Use file mode when you want a closer drop-in replacement for Phrase Strings CLI file workflows. See phrase for commands, flags, and examples.

Native sync mode

Required config

{
  "storage": {
    "adapter": "phrase",
    "config": {
      "projectID": "project-uuid",
      "apiTokenEnv": "PHRASE_API_TOKEN",
      "mode": "strings"
    }
  }
}

Optional config fields

sourceLanguage
targetLanguages
timeoutSeconds
fileFormat (required when mode is files)

Modes

strings: pull and push using Phrase key and translation APIs.
files: pull and push using Phrase export/import jobs.

Phrase-compatible file mode

Use .phrase.yml. If --config is omitted, Hyperlocalise checks PHRASEAPP_CONFIG, then .phrase.yml in the current directory, then $HOME/.phrase.yml. See phrase for the full command tree, supported config fields, and the gap list versus the official Strings CLI.

Common issues

token not found: export PHRASE_API_TOKEN
mode validation error: set mode to strings or files
file mode import failure: verify fileFormat matches your project settings

​Two Phrase workflows

​Native sync mode

​Required config

​Optional config fields

​Modes

​Phrase-compatible file mode

​Common issues