Skip to documentation
DocumentationGetting started

Your first translation

Take a message from your repository to ReRune and back into your app. This walkthrough covers workspace setup, a first sync, and optional runtime delivery.

On this page

Set up with your coding agent

Want a coding agent to do the setup? Run one command from the root of your Git repository. A local wizard inspects the app and confirms the plan with you before anything changes. Then it opens the coding agent you already use with a migration and validation workflow for your stack. The sections below are the manual path.

macOS and Linux

curl -fsSL https://rerune.io/onboard.sh | sh

Windows (PowerShell 5.1 or 7)

irm https://rerune.io/onboard.ps1 | iex

  1. Repository: finds the Git repository of the current folder.
  2. Application and localization: detects the app stack and its current localization setup.
  3. ReRune setup: can store your CLI API key and, after a separate authenticated approval, create a project OTA Publish ID.
  4. Git safety: lets you choose the branch and reports existing changes before it continues.
  5. Coding agent: lists the supported coding agents installed on your machine for you to pick.
  6. Review and launch: shows a summary, then hands the selected agent the migration workflow.

The script runs locally. ReRune does not receive your source code or list of installed agents.

To run a fixed release, use the versioned script URL. The changelog lists every version and what changed.

Fixed release on macOS and Linux

curl -fsSL https://rerune.io/onboard/v1.2.11/onboard.sh | sh

Fixed release on Windows

irm https://rerune.io/onboard/v1.2.11/onboard.ps1 | iex

1. Create a project

Sign in to ReRune and select your organisation. Create a project for the application you want to localize. Choose a main language that your team can use as the source, then add a target language with its language code and display name.

Add a description of the product and its audience, and guidelines for tone and formatting, so collaborators can interpret short messages. To guide AI translation, fill in Project Context and Translation Style in AI Settings and add key terms to the Glossary.

2. Add your source text

If your app already has locale files, open the project translations and import a file with the matching platform format and language. Otherwise, create a key such as checkout_continue and enter its main-language value. Use the same identifier in your app.

Fill in the target-language value. Preserve named arguments, quantity variables, and message structure. Add notes when the meaning depends on where the text appears.

3. Connect your repository

Install the CLI, create an API key in your account, and run rerune in your application directory. The interactive setup selects the project, platform, and translation folder and writes rerune.json. Keep the API key in your local environment or an untracked .env file.

Terminal · interactive setup

rerune

Commit or back up your current locale files before the first sync. Run pull, inspect the changes, then run your app and check the message in both languages. Run any code generation your localization framework requires.

Terminal · sync translations

rerune pull

4. Add runtime delivery

For OTA delivery, generate an OTA Publish ID in the project settings and follow your SDK chapter. Keep native fallback resources in the app. Publish the reviewed key in the dashboard, then trigger an SDK update check and verify the visible value.

Test once with a network connection and once offline. A fresh offline install needs bundled text; a later offline launch can use retained SDK cache. Editing a draft alone does not change the published text.

From published text to the running app

Edit a translation, publish it, and refresh the app to see the new text without another application release.

Watch on YouTube