Skip to main content
Connect your repository to Hyperlocalise Platform so your team can translate and review in a shared workspace while you deliver through Git and CI. Upload source files with the CLI, manage translation in Platform, and pull project translations back into your app. Before you begin, install Hyperlocalise CLI and create a project. You will connect it with an API key.

​
Create an API key

  1. Open Settings → API Keys.
  2. Click Create API key.
  3. Enter a Key name such as Production CI.
  4. Click Create key.
  5. Click Copy. Platform shows the secret once.
Treat the key like a password. Do not commit it to git. Revoke it from the same page if it leaks. Default permissions are files:read, files:write, jobs:read, and jobs:write. The CLI sync commands need file read and write. Job permissions matter when your own scripts create or poll jobs.

​
Point the CLI at the project

Open the project, then Settings. The Connect CLI & CI panel shows the Project ID and a Sample i18n.yml. Copy both. Keep the sample file mappings, then adjust them to match your repository. For example, this configuration uploads locales/en-US.json and maps Spanish translations to locales/es-ES.json:
The CLI configuration requires an llm.profiles entry. Platform sync does not use it to generate translations or require an OpenAI key; it is used if you also run local translation. Replace project_123 with your project ID and save the configuration as i18n.yml in your repository root. You can set project_id_env instead of project_id when the id should come from the environment. Field details are in i18n config. For the Platform workflow on this page, sync push and sync pull use the top-level hyperlocalise block. When that block is absent, the same commands can use storage.adapter for TMS entry sync. If both blocks are present, Platform takes precedence. Set the env var named in api_key_env (default HYPERLOCALISE_API_KEY) in your shell or CI secrets. The CLI sends it as the x-api-key header to api_base_url.
The sample config in Platform uses https://hyperlocalise.com/api. Requests then hit /v1/... on that host, for example POST https://hyperlocalise.com/api/v1/files.

​
Push sources

During a real push, the CLI reads source files from i18n.yml buckets and uploads each file. It does not enqueue translation jobs. Configure a Source upload automation, or start a run from New Request, when you want Platform to translate after upload. See sync push.

​
Pull translations

For each source file and target locale, the CLI reconstructs the translated file from project translation state and writes it to the target path in i18n.yml. It does not read job IDs. If no translation exists for a path and locale, pull skips that file. See sync pull.

​
CI

Keep the key in your CI secret manager. Inject it only in jobs that call hyperlocalise sync. Commit api_key_env, not the secret. Use --dry-run in pull-request checks. Run a real pull or push only in jobs that are allowed to write. Install the binary with the GitHub Action:

​
What the CLI does not do here

  • It does not replace CAT review. Reviewers still work in Platform.
  • Provider commands such as crowdin and phrase keep their own config. Those are TMS adapters, not Platform native sync.
  • Local run / eval still use LLM provider credentials from i18n.yml. See the CLI docs.

​
Next