Git extension for versioning large files
Go Shell Other
Latest commit e5bc6b9 Dec 14, 2017 @ttaylorr ttaylorr Merge pull request #2773 from git-lfs/lock-send-ref
send remote refspec for the other lock commands
Permalink
Failed to load latest commit information.
commands Merge branch 'master' into lock-send-ref Dec 14, 2017
config config: add PushRemote() for checking branch.*.pushRemote and remote.… Nov 3, 2017
debian release v2.3.4 Oct 18, 2017
docker docker: add debian_9 image to default images list May 8, 2017
docs docs,locking: add `ref` property to API docs and schema Dec 14, 2017
errors Fix parentOf function to work with updated github.com/pkg/errors Jul 18, 2017
filepathfilter filepathfilter: convert paths on windows Nov 20, 2017
fs lfs: remove LocalMediaPath() Oct 25, 2017
git git/odb: remove extra newline from Tag formatting Dec 14, 2017
lfs progress,tools: move CopyCallback (and related) to 'tools' Nov 22, 2017
lfsapi lfsapi/client: ensure a consistent User-Agent: header Nov 16, 2017
locking locking: update schemas correctly Dec 14, 2017
rpm release v2.3.4 Oct 18, 2017
script Merge branch 'master' into release-ubuntu-artful Nov 20, 2017
subprocess git: run 'config' from dir based on *Configuration Oct 26, 2017
tasklog Merge branch 'master' into progress-remove-meter Dec 7, 2017
test Merge branch 'master' into lock-send-ref Dec 14, 2017
tools tools: add empty functions when missing in *SyncWriter Dec 1, 2017
tq tq: remove MeterOptions in favor of fields Dec 7, 2017
vendor/github.com update tracerx to add timestamps Sep 27, 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 ci: disable integration tests on 'next' branch of git Aug 24, 2017
CHANGELOG.md release v2.3.4 Oct 18, 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 Allow using custom transfer agents directly Jul 31, 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 ci: disable integration tests on 'next' branch of git Aug 24, 2017
git-lfs.go Specify the embedded Windows icon as part of versioninfo.json Dec 5, 2017
glide.lock update tracerx to add timestamps Sep 27, 2017
glide.yaml update tracerx to add timestamps Sep 27, 2017
versioninfo.json Specify the embedded Windows icon as part of versioninfo.json Dec 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

By default, the Git LFS client needs a Git LFS server to sync the large files it manages. This works out of the box when using popular git repository hosting providers like GitHub, Atlassian, etc. When you host your own vanilla git server, for example, you need to either use a separate Git LFS server instance, or use the custom transfer adapter with a transfer agent in blind mode, without having to use a Git LFS server instance.

You can install the Git LFS client 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 http://www.oddjack.com/?certs=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