Getting started

​

Cloud workspace

​

Sign in

1. Go to hyperlocalise.com.
2. Sign in with the identity provider your team uses.
3. Select an organization, or create one if you are the first member.

​

Create a project

1. Open Projects in the sidebar.
2. Create a project and give it a name your team will recognize.
3. Choose the source locale and the target locales you need now. You can add more later.

​

Add source content

1. Click Add files.
2. Stage JSON, YAML, XLIFF, PO, images, Office files, or other supported formats.
3. Click Upload.

​

Review

​

CLI and CI

1. Install the CLI.
2. In Cloud, create the project as above, then copy the Project ID from project Settings → Connect CLI & CI.
3. Create an organization key under Settings → API Keys. Copy it once. You will not see it again.
4. Add a hyperlocalise block to i18n.yml and set HYPERLOCALISE_API_KEY in the environment.

hyperlocalise:
  project_id: project_123
  api_base_url: https://hyperlocalise.com/api
  api_key_env: HYPERLOCALISE_API_KEY
  timeout_seconds: 1200

5. Preview, then upload sources:

hyperlocalise sync push --dry-run
hyperlocalise sync push

6. After translations exist in the project, write them back to local paths:

hyperlocalise sync pull --dry-run
hyperlocalise sync pull

​

Next

• CAT
• Automations
• Public API