Git

Overleaf's Git integration is a premium feature. Overleaf premium features are available to participants in Overleaf Commons, members of group subscriptions, and owners of individual subscriptions. Git integration is available on Overleaf Cloud and Overleaf Server Pro (version 4.0 and later).

What is the Overleaf Git integration?

Overleaf's Git integration allows you to obtain a Git URL from your Overleaf project and treat it like a remote Git repository (repo). You can clone your project to a local Git repository and work on your project locally, pushing changes to your project from your local machine and pulling updates that are occurring in Overleaf's online editor to your local repo.

This allows you to work on your project locally for those times when online work is not feasible, to use a different local editor of your choice when working on an Overleaf project, or to easily add outputs from other local software to your Overleaf project.

You can obtain the Git URL and clone command for your project from the Git option in your project's menu.

How to authenticate when using the Git integration

When you perform a Git operation such as clone, pull, or push to your remote Overleaf project, you will be asked to authenticate.

To access your Overleaf project from Git, you must use Overleaf token-based authentication. For step-by-step instructions see: Git integration authentication tokens.

Cloning your project as a local repository

From the Menu within your project, select Git from the Synchronization options. This will bring up a dialog showing the git clone command to use when creating your local repository.

Alternately, you can find the Git URL from the project URL (the URL in the browser address bar when you're in a project).

Overleaf Cloud

If you're using Overleaf Cloud and your Overleaf project URL looks like:

https://www.overleaf.com/project/1234567

Then the Git URL to use to clone the project will be:

https://git.overleaf.com/1234567

And the command used to clone the project into a local Git repository will be:

git clone https://git.overleaf.com/1234567

Overleaf Server Pro (version 4.0 or later)

Note: The Git-bridge integration is not enabled by default in Server Pro. Please see our Git Integration guide for instructions on how to enable it.

If you're using Overleaf Server Pro and your Project URL looks like this:

https://<SHARELATEX_SITE_URL>/project/1234567

Then the Git URL used when cloning the project will be:

https://git@<SHARELATEX_SITE_URL>/git/1234567

And the command used to clone the project into a local Git repository using the Git command line will be:

git clone git@<SHARELATEX_SITE_URL>/git/1234567

Note: You may be prompted for a password. Please see: Git integration authentication tokens