Git LFS

L. Larrabee Strow

1 Introduction to Git LFS

It is much easier to store large files on github using git-lfs. In fact, github does not allow you to push a file larger than 100 MBytes that is committed to git.

See https://help.github.com/categories/managing-large-files/ for some details.

git calls git-lfs when needed to manage these large files. git-lfs is installed on /asl/opt/bin/git-lfs so make sure /asl/opt/bin/ is in your shell path.

2 Set up

First check that git-lfs is working by doing git lfs install. If you see a message that "Git LFS initialized" you are good to go.

The github help page at https://help.github.com/articles/configuring-git-large-file-storage/ shows you how to use git lfs.

Generally you would want to do something like git lfs track "*.mat" or =git lfs track "*.rtp" to ensure that your large files are handled by git using git-lfs.

You should also save (or look at) .gitattributes to see what is being handled in the repo by git-lfs. This file should always be committed.

3 Normal use

Often someone else will set up the repo to use git-lfs and you don't need to do anything. If git-lfs is in your path, all use of git-lfs should be transparent.

The one problem with git-lfs is that we cannot have a local repo, since setting up a git repo server with git-lfs is a big deal, so we can only use github.com for this.