Skip to content
Git extension for versioning large files
Go Shell Makefile Other
Branch: master
Clone or download

Latest commit

bk2204 Merge pull request #4143 from bk2204/macos-ci
Sign and notarize binaries on macOS
Latest commit 8badaa9 Jun 1, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci circleci: remove blank lines from config Jul 11, 2019
.github workflows/release: sign and notarize macOS binaries May 29, 2020
commands Allow locking/unlocking of nonexistent files May 11, 2020
config release: v2.11.0 May 6, 2020
creds creds: move Access types into creds package Dec 9, 2019
debian release: v2.11.0 May 6, 2020
docker CI: prune unused Docker images after use Apr 17, 2020
docs docs/man/mangen: format output according to goimports May 29, 2020
errors Fix error strings to follow Go guidelines Oct 22, 2019
filepathfilter filepathfilter: don't say file is both accepted and rejected Nov 2, 2018
fs Fix error strings to follow Go guidelines Oct 22, 2019
git git: consider full refspec when determining seen refs May 18, 2020
lfs Check error when creating local storage directory Feb 10, 2020
lfsapi lfs{api,http}: test bare repo local path endpoints Apr 2, 2020
lfshttp Allow literal local paths as remotes May 6, 2020
locking locking: make patterns with slashes work on Windows May 18, 2020
rpm release: v2.11.0 May 6, 2020
script workflows/release: sign and notarize macOS binaries May 29, 2020
subprocess Support submodule.recurse = true Mar 10, 2020
t locking: make patterns with slashes work on Windows May 18, 2020
tasklog tasklog/log.go: print "done" messages with a trailing period Aug 23, 2019
tools fix upload retry 'file already closed' issue' Feb 26, 2020
tq tq: add exponential backoff for retries Apr 15, 2020
vendor Update stretchr/testify to v1.5.1 Apr 15, 2020
.gitattributes Enable autocrlf Aug 23, 2015
.gitignore t: store test_count{,.lock} in t, not t/remote Jul 11, 2018
.mailmap Add myself to .mailmap Feb 24, 2017
.travis.yml Make Travis run tests on the proper version Aug 5, 2019
CHANGELOG.md release: v2.11.0 May 6, 2020
CODE-OF-CONDUCT.md embed the open code of conduct since the link is bad now May 6, 2016
CONTRIBUTING.md CONTRIBUTING: reflect the supported versions of Go Dec 11, 2019
INSTALLING.md update other github/git-lfs references Nov 15, 2016
LICENSE.md updated copyright year Jan 22, 2020
Makefile workflows/release: sign and notarize macOS binaries May 29, 2020
README.md README: explain how to verify releases Feb 14, 2020
appveyor.yml all: use Go 1.11.1 in CI Oct 2, 2018
git-lfs.go Run go generate only on Windows Jan 15, 2019
git-lfs_windows.go Run go generate only on Windows Jan 15, 2019
go.mod Update stretchr/testify to v1.5.1 Apr 15, 2020
go.sum Update stretchr/testify to v1.5.1 Apr 15, 2020
versioninfo.json release: v2.11.0 May 6, 2020

README.md

Git Large File Storage

CI 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

Downloading

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. Git LFS is included in the distribution of Git for Windows. Alternatively, you can install a recent version of Git LFS from the Chocolatey package manager.
  • Binary packages. In addition, binary packages are available for Linux, macOS, Windows, and FreeBSD.
  • Building from source. This repository can also be built from source using the latest version of Go, and the available instructions in our Wiki.

Installing

From binary

The binary packages include a script which will:

  • Install Git LFS binaries onto the system $PATH
  • Run git lfs install to perform required global configuration changes.
$ ./install.sh

From source

  • Place the git-lfs binary on your system’s executable $PATH or equivalent.
  • Git LFS requires global configuration changes once per-machine. This can be done by running:
$ git lfs install

Verifying releases

Releases are signed with the OpenPGP key of one of the core team members. To get these keys, you can run the following command, which will print them to standard output:

$ curl -L https://api.github.com/repos/git-lfs/git-lfs/tarball/core-gpg-keys | tar -Ozxf -

Once you have the keys, you can download the sha256sums.asc file and verify the file you want like so:

$ gpg -d sha256sums.asc | grep git-lfs-linux-amd64-v2.10.0.tar.gz | shasum -a 256 -c

Example Usage

To begin using Git LFS within a Git repository that is not already configured for Git LFS, you can indicate which files you would like Git LFS to manage. This can be done by running the following from within a 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).

Note: the quotation marks surrounding the pattern are important to prevent the glob pattern from being expanded by the shell.

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" --everything

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 https://github.com/git-lfs/git-lfs-test
   67fcf6a..47b2002  master -> master

Note: Git LFS requires at least Git 1.8.2 on Linux or 1.8.5 on macOS.

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:

@bk2204 @larsxschneider

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 @PastelMobileSuit @rubyist @sinbad @technoweenie @ttaylorr
You can’t perform that action at this time.