Using OverLINCS Git#

Overleaf Community Edition doesn’t provide native Git-like functionalities, but Irisa has built a nice Git bridge from which OverLincs Git builds upon.

The idea is to have a regular git installed locally, with an emulation of a remote git provided by the bridge.

In short:

  • Use olincs instead of git for clone, push, and pull, i.e. all remote interactions.

  • Use git for commit and add, i.e. purely local updates.

  • git rm is not fully supported. File deletion should be performed directly on OverLincs.

  • As a general rule, other commands should be avoided, OverLincs Git only addresses the basic pull/commit/push cycle.

Note: you can also use git olincs clone/pull/push if you prefer.

Cloning an OverLincs repository#

$ olincs clone REMOTE_URL LOCAL_DIRECTORY

For example:

$ olincs clone https://overleaf.lincs.fr/project/6568a676f421bb1300173f2c mydir

Retrieve remote changes#

Inside your local repository:

$ olincs pull

If you end up with conflicts, you’ll have to resolve them manually, like in a regular git.

Upload local changes#

Add files#

Add files with git add:

$ git add nice_picture.png
$ git add *.bib

Remove files#

Don’t. Remove files on server side and do olincs pull.

Commit changes#

Commit files with git commit, e.g.:

$ git commit -a -m "Modification description"

Push#

$ olincs push

Note that OverLincs Git automatically performs a pull before pushing so you do not need to do it manually.