Use this app to exchange files with your GitHub repository. 

Once the app is set up, you can manually pull files through the Lokalise web dashboard or set up automatic pulls, so files are imported automatically when pushed to GitHub by your dev team.

When translations are done, you can trigger a pull request on GitHub from the Download page.

Open your Lokalise project and navigate to Apps.

Find GitHub in the list of apps, click on it, press Install, and then Connect.

You used to need a special access token from GitHub, but now it's all done through OAuth 2. You can still use personal access tokens for existing setups, but new ones use OAuth. Just click Connect and give Lokalise Apps the needed access rights. The repo scope is required.

Enter the Repository name (prefixed with your organization name) and the Branch to pull from:

As you export files from Lokalise, you can set the GitHub app to create pull requests to repos matching the exported file format.

Decide if you want filenames to include a full path. Usually, you don’t need it since you can set the directory structure prefix during pull request creation. But if you have similar files in different subfolders (e.g., admin/locale.json and frontend/locale.json), enable the Include path in filenames option. Note that if you already have files uploaded, including a path in filenames here means you're uploading different files.

Look through the selected repository and choose the files you want to pull and import.

After selecting a file, choose the language of the file from the dropdown menu:

Once the files are pulled, you can find your translation data in the Editor:

If you want to keep all platform files in the same project, you might need to set up other repositories related to the same project. Click Add another repo to add more repositories.

If you're connecting Lokalise to a GitHub organization and encounter errors after logging in and granting access, follow these steps:

After completing these steps, return to the Setup section and try connecting your repository again.

se the Pull now button on the app page. Clicking this button adds the pull to the system queue to be executed in the background.

If you need to adjust options, click Pull options on the app page. These options are similar to those on the Upload page.

Once you're satisfied with the initial pull results, set up a webhook in GitHub to automate pulling changes to Lokalise as you push to GitHub.

To create a new pull request on GitHub with all the changes made on Lokalise, go to the Download page and find the App triggers section. Enable the GitHub option:

Use the Preview button first to see the resulting file/folder structure before triggering the creation of a pull request:

We recommend triggering pull requests only to repos matching the file type you're exporting (e.g., JSON format for Web platform repos).

Press Build only to create the pull request without downloading a translation bundle to your local PC. To check the status of the pull request creation, return to the GitHub app page and click the Logs button.

Here's what happens after triggering a new PR:

To initiate a pull request from the API, use triggers=['github'] parameter with the /export endpoint. For the CLI tool, use --triggers=github as a parameter when performing the export.

This app allows you to exchange files with a self-hosted GitHub Enterprise. You'll need to provide a URL to the server where your GitHub is hosted and a personal token when setting up the app.

To generate a personal access token:

Apart from that, this feature works the same way as the regular GitHub app.

Lokalise requests access to all repositories to list them during setup so you can specify which repository to connect to Lokalise. There is no more restrictive OAuth scope for this purpose. Once the app is configured, Lokalise only works with the repository you selected. Admin scopes are not required.

Lokalise only creates merge requests and fetches the files you selected during setup. The Lokalise GitHub app does not alter the repo’s settings.

GitHub user permission scopes limit access for OAuth tokens. The Lokalise app’s access is limited by the permissions of the user who configures the integration. If you need to limit the integration’s access to a specific repository, you can do so by limiting the permissions of the authorizing user’s GitHub account.

GitHub users can always revoke a token or edit the token scopes for more control over what the integration can do.

Your token is stored in an encrypted form in our database. The database itself is stored on dedicated servers at the Hetzner Online provider, which ensures top-level physical security. You can learn more on the Hetznet website.

We take regular snapshots of the database and store them in a 256-bit encrypted Amazon S3 bucket for 30 days.