Git extension for versioning large files
Go Shell Other
Latest commit 8dea8fe Jul 17, 2017 @ttaylorr ttaylorr committed on GitHub Merge pull request #2425 from ssgelm/update-gitignore-debian
Update gitignore to add some temp files that get created when building debs
Permalink
Failed to load latest commit information.
commands Merge pull request #2023 from bozaro/lfs-storage Jul 12, 2017
config Add lfs.storage parameter for overriding LFS storage location Jul 7, 2017
debian bump package versions Jun 27, 2017
docker docker: add debian_9 image to default images list May 8, 2017
docs Merge pull request #2023 from bozaro/lfs-storage Jul 12, 2017
errors Move retry logic to errors.IsRetrialbeError Jun 14, 2017
filepathfilter filepathfilter: return include/exclude patterns via Include(), Exclude() Jun 23, 2017
git Merge pull request #2388 from git-lfs/migrate-rm-tmp-files Jul 5, 2017
lfs Merge pull request #2023 from bozaro/lfs-storage Jul 12, 2017
lfsapi Merge branch 'master' into x-scheme-redirect May 19, 2017
localstorage Add lfs.storage parameter for overriding LFS storage location Jul 7, 2017
locking logging for lfs verify and locking requests Apr 27, 2017
progress progress: remove 'var _' decls Feb 18, 2017
rpm all: bump version to '2.3.0-pre' Jul 5, 2017
script Merge branch 'master' into packagecloud-fmt May 10, 2017
subprocess Fix for #1874 Jan 19, 2017
test Merge pull request #2023 from bozaro/lfs-storage Jul 12, 2017
tools tools: remove unnecessary files Jul 6, 2017
tq Move retry logic to errors.IsRetrialbeError Jun 14, 2017
vendor/github.com vendor: remove github.com/cheggaaa/pb Jul 5, 2017
.gitattributes Enable autocrlf Aug 23, 2015
.gitignore Update gitignore to add some temp files that get created when buildin… Jul 17, 2017
.mailmap Add myself to .mailmap Feb 24, 2017
.travis.yml travis,circle: bump minimum version to 2.0.0 Jun 23, 2017
CHANGELOG.md Bump version and changelog Jun 26, 2017
CODE-OF-CONDUCT.md embed the open code of conduct since the link is bad now May 6, 2016
CONTRIBUTING.md config: bump version to '2.0-pre' so it's clear you're not on an offi… Feb 9, 2017
INSTALLING.md update other github/git-lfs references Nov 15, 2016
LICENSE.md Add copyright date to license Nov 23, 2016
Makefile update other github/git-lfs references Nov 15, 2016
README.md all: build on Go 1.8.1 Apr 10, 2017
ROADMAP.md update other github/git-lfs references Nov 15, 2016
appveyor.yml all: build on go1.8.3 May 24, 2017
circle.yml travis,circle: bump minimum version to 2.0.0 Jun 23, 2017
git-lfs.go Use goversioninfo instead of windres to embed Windows resources Dec 15, 2016
glide.lock vendor: remove github.com/cheggaaa/pb Jul 5, 2017
glide.yaml vendor: remove github.com/cheggaaa/pb Jul 5, 2017
versioninfo.json all: bump version to '2.3.0-pre' Jul 5, 2017

README.md

Git Large File Storage

Linux macOS Windows
Linux build status macOS build status Windows build status

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 an overview of features.

Getting Started

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

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

Once installed, you need to setup the global Git hooks for Git LFS. This only needs to be done once per machine.

$ git lfs install

Now, it's time to add some large files to a repository. The first step is to specify file patterns to store with Git LFS. These file patterns are stored in .gitattributes.

$ mkdir large-repo
$ cd large-repo
$ git init

# Add all zip files through Git LFS
$ git lfs track "*.zip"

Now you're ready to push some commits:

$ git add .gitattributes
$ 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
LFS: 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/git-lfs/git-lfs-test
   67fcf6a..47b2002  master -> master

Need Help?

You can get help on specific commands directly:

$ git lfs help <subcommand>

The official documentation has command references and specifications for the tool. You can ask questions in the Git LFS chat room, or file a new issue. Be sure to include details about the problem so we can troubleshoot it.

  1. Include the output of git lfs env, which shows how your Git environment is setup.
  2. Include GIT_TRACE=1 in any bad Git commands to enable debug messages.
  3. If the output includes a message like Errors logged to /path/to/.git/lfs/objects/logs/*.log, throw the contents in the issue, or as a link to a Gist or paste site.

Contributing

See CONTRIBUTING.md for info on working on Git LFS and sending patches. Related projects are listed on the Implementations wiki page. You can also join the project's chat room.

Using LFS from other Go code

At the moment git-lfs is only focussed on the stability of its command line interface, and the server APIs. The contents of the source packages is subject to change. We therefore currently discourage other Go code from depending on the git-lfs packages directly; an API to be used by external Go code may be provided in future.

Core Team

These are the humans that form the Git LFS core team, which runs the project.

In alphabetical order:

@andyneff @rubyist @sinbad @technoweenie @ttaylorr