Skip to main content
Application Resource Bundle (ARB) files store Flutter messages and their metadata in JSON. Hyperlocalise translates message values while carrying message metadata through writeback and updating the target locale. Supported extensions: .arb.

Source file

Save this example as locales/en-US/messages.arb.

Configure your files

Use this i18n.yml for the example, or add its file mapping to your existing bucket. See path templates for other layouts.

Translate

Install the CLI and set OPENAI_API_KEY in your project’s .env.local or shell. You can also configure another AI provider.
The dry run previews the work. The second command writes translations to the configured target path and updates the lockfile.

Behavior and limitations

  • Top-level message keys are translated. Keys beginning with @, including @@locale and @message objects, are metadata.
  • Writeback preserves target metadata and carries source metadata forward for newly added messages.
  • @@locale is updated to the target locale. Keep ICU placeholders and plural expressions in the message strings.

Next steps