You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
brian m. carlson 731bcc598b
Merge pull request #4368 from bk2204/prune-force
1 week ago
.circleci circleci: remove blank lines from config 1 year ago
.github .github/workflows: remove special ::add-path commands 2 months ago
commands prune: add options to be more aggressive about pruning 1 week ago
config release: v2.13.0 1 month ago
creds Use subprocess for invoking all commands 1 month ago
debian release: v2.13.0 1 month ago
docker Drop support for Debian 8 1 month ago
docs prune: add options to be more aggressive about pruning 1 week ago
errors Fix error strings to follow Go guidelines 1 year ago
filepathfilter filepathfilter: add an option for stricter matching 2 months ago
fs fs: don't panic when using a too-short object ID to push 2 months ago
git git: match gitattributes patterns strictly 2 months ago
lfs prune: add options to be more aggressive about pruning 1 week ago
lfsapi lfs{api,http}: test bare repo local path endpoints 9 months ago
lfshttp Use subprocess for invoking all commands 1 month ago
locking locking: don't assume files are lockable if no patterns exist 6 months ago
rpm release: v2.13.0 1 month ago
script script/packagecloud: add some additional distros 1 month ago
subprocess subprocess: avoid using relative program names 2 months ago
t prune: add options to be more aggressive about pruning 1 week ago
tasklog tasklog/log.go: print "done" messages with a trailing period 1 year ago
tools tools: use ERROR_SHARING_VIOLATION const from golang.org/x/sys/windows 2 months ago
tq tq: add exponential backoff for retries 9 months ago
vendor vendor: vendor gitobj v2.0.1 1 month ago
.gitattributes Enable autocrlf 5 years ago
.gitignore t: store test_count{,.lock} in t, not t/remote 2 years ago
.mailmap Add myself to .mailmap 3 years ago
.travis.yml Make Travis run tests on the proper version 1 year ago
CHANGELOG.md release: v2.13.0 1 month ago
CODE-OF-CONDUCT.md embed the open code of conduct since the link is bad now 4 years ago
CONTRIBUTING.md CONTRIRBUTING: rephrase introductory paragraph 4 months ago
INSTALLING.md update other github/git-lfs references 4 years ago
LICENSE.md subprocess: avoid using relative program names 2 months ago
Makefile Makefile: allow make release to be run twice in a row 1 month ago
README.md README: add a link to the FAQ 4 months ago
SECURITY.md {README,SECURITY}.md: add security bug report docs 4 months ago
appveyor.yml all: use Go 1.11.1 in CI 2 years ago
git-lfs.go Run go generate only on Windows 2 years ago
git-lfs_windows.go Run go generate only on Windows 2 years ago
go.mod Bump version of gitobj 1 month ago
go.sum Bump version of gitobj 1 month ago
versioninfo.json release: v2.13.0 1 month ago

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)`](https://github.com/git-lfs/git-lfs/blob/master/docs/man/git-lfs-migrate.1.ronn).

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

```bash
$ 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. There’s also a FAQ on the wiki which answers some common questions.

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.

See also SECURITY.md for info on how to submit reports of security vulnerabilities.

Core Team

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

In alphabetical order:

@bk2204 @chrisd8088 @larsxschneider
PGP 0223B187 PGP 088335A9 PGP A5795889

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