Smartling adapter - Hyperlocalise

Two Smartling workflows

Hyperlocalise supports two Smartling integrations:

Native sync mode with i18n.yml plus sync push / sync pull
Flag-driven file commands with hyperlocalise smartling ...

Use native sync mode when you want Hyperlocalise-managed entry sync. Use the file commands when you want to upload and download Smartling files by --project-id and --file-uri. See smartling for commands, flags, credential env vars, and the gap list versus official smartling-cli. Hyperlocalise does not read smartling.yml yet.

Native sync mode

Required config

{
  "storage": {
    "adapter": "smartling",
    "config": {
      "projectID": "your-project-id",
      "userIdentifier": "your-smartling-user-identifier",
      "userSecretEnv": "SMARTLING_USER_SECRET"
    }
  }
}

Required secret

export SMARTLING_USER_SECRET="your-smartling-user-secret"

userSecret inline in config is not supported. Use environment variables only.

Optional config fields

targetLanguages
timeoutSeconds (defaults to 30)
mode — strings (default) or files
fileURI — required when mode is files
fileFormat — required when mode is files (for example json)

Modes

strings: pull and push using Smartling string APIs.
files: pull and push using Smartling file download/upload APIs.

Files mode config example

{
  "storage": {
    "adapter": "smartling",
    "config": {
      "projectID": "your-project-id",
      "userIdentifier": "your-smartling-user-identifier",
      "userSecretEnv": "SMARTLING_USER_SECRET",
      "mode": "files",
      "fileURI": "translations.json",
      "fileFormat": "json"
    }
  }
}

Common issues

missing secret: export SMARTLING_USER_SECRET in the same shell session (native sync and file commands). Official smartling-cli uses SMARTLING_SECRET; Hyperlocalise does not read that name.
missing user identifier: set storage.config.userIdentifier, or for file commands SMARTLING_USER_IDENTIFIER / --user-id (not official SMARTLING_USER_ID)
locale mismatch: align targetLanguages with your project locales
file mode import failure: verify fileFormat matches your project settings

​Two Smartling workflows

​Native sync mode

​Required config

​Required secret

​Optional config fields

​Modes

​Files mode config example

​Common issues