GitHub App
Connect your repository to Localhero.ai. The App handles setup and syncs translations from the dashboard back to your code.
The Localhero.ai GitHub App is optional. You can also get things going with the CLI and use the GitHub Action on its own.
What the App Does
Repository setup
When you connect a repository, the App analyzes it to detect your framework, translation file format, and file locations. If it doesn't find an existing GitHub Action workflow file or localhero.json, it opens a pull request with both. Nothing is committed to your repo directly, you review and merge the PR yourself.
Export to GitHub
When you edit translations on Localhero.ai and want them in your codebase, click Export to GitHub in the top right of the translations page. You pick which keys to include and add an optional PR message. The App creates a pull request with the updated translation files for you to review and merge.
On PR-specific pages, you'll see a Sync to GitHub button that pushes edits for that specific PR back to the branch.
PR awareness
The App keeps track of your PRs. When a PR with new translation keys is merged, those keys become part of your project. If the PR is closed without merging, the pending keys are cleaned up automatically.
The App itself doesn't run translations. That's the job of the GitHub Action, which runs the CLI on your GitHub Actions runner.
Installing the GitHub App
Install the app
Go to your project in the dashboard and click "Connect to GitHub". You can also find this under Settings → General in your project. This installs the Localhero.ai GitHub App on your organization or personal account.
Select a repository
Choose which repository to connect to your Localhero.ai project. The App analyzes the repository to detect your framework, translation file format, and file locations.
Review the setup PR
If your repo doesn't already have the config files, the App opens a pull request with:
- •
localhero.jsonwith your project configuration - •
.github/workflows/localhero-translate.ymlwith the translation workflow
Review the PR, adjust if needed, and merge. Once merged, the Action translates automatically on every future PR that touches your translation files.
Already have a workflow? If your repo already has localhero.json and a workflow file (e.g. from running npx @localheroai/cli init), the App skips setup and connects directly.
App vs Action vs CLI
Three tools, each with a different job:
| GitHub App | GitHub Action | CLI | |
|---|---|---|---|
| What it does | Sets up your repo (via PR), syncs from dashboard, tracks PR lifecycle | Runs the CLI in CI to translate and commit to PRs | Translates locally, pushes/pulls keys, manages config |
| Translates? | No | Yes | Yes |
| Where it runs | Localhero.ai servers | GitHub Actions runner | Your machine or CI |
| Required? | Optional. Needed for dashboard sync and automatic setup | For automatic PR translations | For local development and manual workflows |
Permissions
The GitHub App requests these permissions:
| Permission | Why |
|---|---|
| Contents (read & write) | Create branches and commit translation files for sync PRs |
| Pull requests (read & write) | Create setup and sync PRs, track PR lifecycle |
| Metadata (read) | List repositories during setup |
Ready to try it?
Get setup in a couple of minutes. No credit card required.