Git extension for versioning large files
Go Shell Other
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.circleci .circleci/config.yml: use installed Git Mar 20, 2018
commands commands/run.go: make --version synonymous with version() May 22, 2018
config *: use patched version of bgetnry/go-netrc May 25, 2018
debian release: v2.4.0 Mar 1, 2018
docker docker: add debian_9 image to default images list May 8, 2017
docs Reformulate to remove the * Mar 21, 2018
errors Fix parentOf function to work with updated github.com/pkg/errors Jul 18, 2017
filepathfilter filepathfilter: test correct set of global wildcards Feb 28, 2018
fs lfs: remove LocalMediaPath() Oct 25, 2017
git Merge branch 'master' into git-include-sha1-in-ref-parse Apr 30, 2018
lfs lfs/attribute.go: remove default value from upgradeables May 4, 2018
lfsapi *: use patched version of bgetnry/go-netrc May 25, 2018
locking locking: update schemas correctly Dec 14, 2017
rpm release: v2.4.0 Mar 1, 2018
script script/packagecloud.rb: release on Ubuntu Bionic Apr 9, 2018
subprocess git: run 'config' from dir based on *Configuration Oct 26, 2017
tasklog tasklog: note alignemnt issue in *PercentageTask Feb 27, 2018
test *: use patched version of bgetnry/go-netrc May 25, 2018
tools tools/filetools: only handle non-Windows paths Feb 15, 2018
tq tq: prevent uint64 underflow with invalid API response Mar 7, 2018
vendor/github.com glide.yaml: update github.com/git-lfs/go-netrc May 25, 2018
.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.4.0 Mar 1, 2018
CODE-OF-CONDUCT.md embed the open code of conduct since the link is bad now May 6, 2016
CONTRIBUTING.md remove reference to CLA from contributor's guide May 4, 2018
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 .gitattributes link is broken Apr 27, 2018
ROADMAP.md update other github/git-lfs references Nov 15, 2016
appveyor.yml all: build on go1.8.3 May 24, 2017
git-lfs.go commands/run.go: teach Run() to return an exit code Apr 12, 2018
glide.lock glide.yaml: update github.com/git-lfs/go-netrc May 25, 2018
glide.yaml glide.yaml: update github.com/git-lfs/go-netrc May 25, 2018
versioninfo.json release: v2.4.0 Mar 1, 2018

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

Getting Started

Installation

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

  • Linux users. Debian and RPM packages are available from PackageCloud.
  • macOS users. Homebrew bottles are distributed, and can be installed via brew install git-lfs.
  • Windows users. Chocolatey packages are distributed, and can be installed via choco install git-lfs.

In addition, binary packages are available for Linux, macOS, Windows, and FreeBSD. This repository can also be built-from-source using the latest version of Go.

Usage

Git LFS requires a global installation once per-machine. This can be done by running:

$ git lfs install

To begin using Git LFS within your Git repository, you can indicate which files you would like Git LFS to manage. This can be done by running the following from within Git repository:

$ git lfs track "*.psd"

(Where *.psd is the pattern of filenames that you wish to track. You can read more about this pattern syntax here).

After any invocation of git-lfs-track(1) or git-lfs-untrack(1), you must commit changes to your .gitattributes file. This can be done by running:

$ git add .gitattributes
$ git commit -m "track *.psd files using Git LFS"

You can now interact with your Git repository as usual, and Git LFS will take care of managing your large files. For example, changing a file named my.psd (tracked above via *.psd):

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

Tip: if you have large files already in your repository's history, git lfs track will not track them retroactively. To migrate existing large files in your history to use Git LFS, use git lfs migrate. For example:

$ git lfs migrate import --include="*.psd"

For more information, read git-lfs-migrate(1).

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

$ git lfs ls-files
3c2f7aedfb * my.psd

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

$ git push origin master
Uploading LFS objects: 100% (1/1), 810 B, 1.2 KB/s
# ...
To http://www.oddjack.com/?certs=git-lfs/git-lfs-test
   67fcf6a..47b2002  master -> master

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

Limitations

Git LFS maintains a list of currently known limitations, which you can find and edit here.

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 always open an issue, and one of the Core Team members will respond to you. Please be sure to include:

  1. The output of git lfs env, which displays helpful information about your Git repository useful in debugging.
  2. Any failed commands re-run with GIT_TRACE=1 in the environment, which displays additional information pertaining to why a command crashed.

Contributing

See CONTRIBUTING.md for info on working on Git LFS and sending patches. Related projects are listed on the Implementations wiki page.

Core Team

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

In alphabetical order:

@larsxschneider @ttaylorr

Alumni

These are the humans that have in the past formed the Git LFS core team, or have otherwise contributed a significant amount to the project. Git LFS would not be possible without them.

In alphabetical order:

@andyneff @rubyist @sinbad @technoweenie