Git extension for versioning large files
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.
You can install the Git LFS client in several different ways, depending on your setup and preferences.
brew install git-lfs.
The binary packages include a script which will:
git lfs installto perform required global configuration changes.
go get github.com/josephspurrier/goversioninfo/cmd/goversioninfo.
git-lfsbinary, which can be found in
bin, on your system’s executable
$ git lfs install
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.ascfile 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
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"
*.psdis 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-untrack(1), you must commit changes to your
.gitattributesfile. 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
$ git add my.psd $ git commit -m "add psd"
Tip: if you have large files already in your repository's history,git lfs trackwill not track them retroactively. To migrate existing large files in your history to use Git LFS, usegit lfs migrate. For example:$ git lfs migrate import --include="*.psd" --everything
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 main Uploading LFS objects: 100% (1/1), 810 B, 1.2 KB/s # ... To https://github.com/git-lfs/git-lfs-test 67fcf6a..47b2002 main -> main
Note: Git LFS requires at least Git 1.8.2 on Linux or 1.8.5 on macOS.
If you've decided that Git LFS isn't right for you, you can convert your repository back to a plain Git repository with
git lfs migrateas well. For example:
$ git lfs migrate export --include="*.psd" --everything
Note that this will rewrite history and change all of the Git object IDs in your repository, just like the import version of this command.
If there's some reason that things aren't working out for you, please let us know in an issue, and we'll definitely try to help or get it fixed.
Git LFS maintains a list of currently known limitations, which you can find and edit here.
Git LFS source code utilizes Go modules in its build system, and therefore this project contains a
go.modfile with a defined Go module path. However, we do not maintain a stable Go language API or ABI, as Git LFS is intended to be used solely as a compiled binary utility. Please do not import the
git-lfsmodule into other Go code and do not rely on it as a source code dependency.
You can get help on specific commands directly:
$ git lfs help
If you have a question on how to use Git LFS, aren't sure about something, or are looking for input from others on tips about best practices or use cases, feel free to start a discussion.
You can always open an issue, and one of the Core Team members will respond to you. Please be sure to include:
git lfs env, which displays helpful information about your Git repository useful in debugging.
GIT_TRACE=1in the environment, which displays additional information pertaining to why a command crashed.
See also SECURITY.md for info on how to submit reports of security vulnerabilities.
These are the humans that form the Git LFS core team, which runs the project.
In alphabetical order:
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: