Skip to main content
The public jobs API contract may evolve while CI workflows stabilize.

​
Usage

hyperlocalise sync push [--config <path>] [flags]

​
Default behavior

sync push submits source files and creates Hyperlocalise jobs by default. Use --dry-run when you want to preview the report without uploading files or creating jobs. During a real push, Hyperlocalise reads configured source files from i18n.yml, uploads each source file to the public Hyperlocalise API, creates file translation jobs, and writes a jobs manifest. Use this manifest as a GitHub Actions artifact for a later sync pull job. sync push uses the top-level hyperlocalise config block. It does not use the storage TMS adapter block.

​
Flags

  • --config: config path
  • --locale: target locale(s), repeatable
  • --manifest: path to the jobs manifest
  • --dry-run: preview only
  • --output: text, json, or markdown
  • --force-conflicts: not supported for Hyperlocalise job sync

​
Example

hyperlocalise sync push --locale es-ES --manifest .hyperlocalise/jobs.json

hl push --locale es-ES

​
Notes

  • A successful manifest has complete: true.
  • A failed partial submission writes complete: false and exits non-zero.
  • sync pull refuses incomplete manifests.
  • Provider-specific TMS commands such as crowdin and phrase keep their own config and behavior.

​
See also