Go to file

Rick Olson 23964ec334 look for GIT_LFS_BUILD_DIR		2015-09-30 17:05:39 -07:00
commands	Merge pull request #681 from github/ls-files-output	2015-09-30 09:47:00 -07:00
debian	bump version	2015-09-30 11:36:25 -07:00
docker	set GIT_LFS_TEST_DIR for docker tests	2015-09-30 13:26:19 -07:00
docs	look for GIT_LFS_BUILD_DIR	2015-09-30 17:05:39 -07:00
git	teach init about --local flag	2015-09-23 11:58:16 -06:00
lfs	bump version	2015-09-30 11:36:25 -07:00
rpm	bump version	2015-09-30 11:36:25 -07:00
script	bump version	2015-09-30 11:36:25 -07:00
test	skip the init --local test too	2015-09-30 16:43:43 -07:00
vendor/_nuts/github.com	my typo fix got merged pretty quickly	2015-08-14 16:58:23 -06:00
.gitattributes	Enable autocrlf	2015-08-22 21:03:44 -04:00
.gitignore	Use man content for `help <cmd>' and '<cmd> --help'	2015-09-14 17:26:57 +01:00
.travis.yml	set GIT_LFS_TEST_DIR for travis tests	2015-09-17 16:47:00 -06:00
CHANGELOG.md	bump version	2015-09-30 11:36:25 -07:00
CONTRIBUTING.md	fix CoC link	2015-09-30 09:51:17 -07:00
git-lfs.go	dump git commit from `script/run version`	2015-07-28 15:32:23 -06:00
LICENSE.md	Rename LICENSE to LICENSE.md	2015-08-04 14:57:11 -07:00
Nut.toml	my typo fix got merged pretty quickly	2015-08-14 16:58:23 -06:00
README.md	Add some more details on installation and documentation	2015-09-25 13:37:07 -06:00
ROADMAP.md	hyperlinks!	2015-08-13 14:02:12 -06:00

README.md

Git Large File Storage

Git LFS is a command line extension and specification for managing large files with Git. The client is written in Go, with pre-compiled binaries available for Mac, Windows, Linux, and FreeBSD. Check out the Git LFS website for a high level overview of features.

See CONTRIBUTING.md for info on working on Git LFS and sending patches. Related projects are listed on the Implementations wiki page. You can chat with the team at: https://gitter.im/github/git-lfs

Getting Started

You can install Git LFS several different ways, depending on your setup and preferences.

Linux users can install Debian or RPM packages from PackageCloud.
Mac users can install from Homebrew with brew install git-lfs.
Binary packages are available for Windows, Mac, Linux, and FreeBSD.

Once installed, you can run git lfs init to setup the global Git hooks necessary for Git LFS to work. You can get help on specific commands directly:

$ git lfs help <subcommand>

The official documentation has command references and specifications for the tool.

Note: Git LFS requires Git v1.8.2 or higher.

Configuration

Git LFS uses .gitattributes files to configure which are managed by Git LFS. Here is a sample one that saves zips and mp3s:

$ cat .gitattributes
*.mp3 filter=lfs -text
*.zip filter=lfs -text

Git LFS can manage .gitattributes for you:

$ git lfs track "*.mp3"
Tracking *.mp3

$ git lfs track "*.zip"
Tracking *.zip

$ git lfs track
Listing tracked paths
    *.mp3 (.gitattributes)
    *.zip (.gitattributes)

$ git lfs untrack "*.zip"
Untracking *.zip

$ git lfs track
Listing tracked paths
    *.mp3 (.gitattributes)

Pushing commits

Once setup, you're ready to push some commits:

$ git add my.zip
$ git commit -m "add zip"

You can confirm that Git LFS is managing your zip file:

$ git lfs ls-files
my.zip

Once you've made your commits, push your files to the Git remote:

$ git push origin master
Sending my.zip
12.58 MB / 12.58 MB  100.00 %
Counting objects: 2, done.
Delta compression using up to 8 threads.
Compressing objects: 100% (5/5), done.
Writing objects: 100% (5/5), 548 bytes | 0 bytes/s, done.
Total 5 (delta 1), reused 0 (delta 0)
To https://github.com/github/git-lfs-test
   67fcf6a..47b2002  master -> master

See the Git LFS overview and man pages.