README
¶
Git Large File Storage
| Linux | macOS | Windows |
|---|---|---|
 |
 |
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.
- Linux users can install Debian or RPM packages from PackageCloud. See the Installation Guide for details.
- Mac users can install from Homebrew with
brew install git-lfs, or from MacPorts withport install git-lfs. - Windows users can install from Chocolatey with
choco install git-lfs. - Binary packages are available for Windows, Mac, Linux, and FreeBSD.
- You can build it with Go 1.8.1+. See the Contributing Guide for instructions.
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 https://github.com/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.
- Include the output of
git lfs env, which shows how your Git environment is setup. - Include
GIT_TRACE=1in any bad Git commands to enable debug messages. - 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 |
|---|---|---|---|---|
 |
 |
 |
 |
 |
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package config collects together all configuration settings NOTE: Subject to change, do not rely on this package from outside git-lfs source
|
Package config collects together all configuration settings NOTE: Subject to change, do not rely on this package from outside git-lfs source |
|
docs
|
|
|
Package errors provides common error handling tools NOTE: Subject to change, do not rely on this package from outside git-lfs source
|
Package errors provides common error handling tools NOTE: Subject to change, do not rely on this package from outside git-lfs source |
|
Package git contains various commands that shell out to git NOTE: Subject to change, do not rely on this package from outside git-lfs source
|
Package git contains various commands that shell out to git NOTE: Subject to change, do not rely on this package from outside git-lfs source |
|
Package lfs brings together the core LFS functionality NOTE: Subject to change, do not rely on this package from outside git-lfs source
|
Package lfs brings together the core LFS functionality NOTE: Subject to change, do not rely on this package from outside git-lfs source |
|
Package localstorage handles LFS content stored locally NOTE: Subject to change, do not rely on this package from outside git-lfs source
|
Package localstorage handles LFS content stored locally NOTE: Subject to change, do not rely on this package from outside git-lfs source |
|
Package progress provides common progress monitoring / display features NOTE: Subject to change, do not rely on this package from outside git-lfs source
|
Package progress provides common progress monitoring / display features NOTE: Subject to change, do not rely on this package from outside git-lfs source |
|
Package subprocess provides helper functions for forking new processes NOTE: Subject to change, do not rely on this package from outside git-lfs source
|
Package subprocess provides helper functions for forking new processes NOTE: Subject to change, do not rely on this package from outside git-lfs source |
|
Package tools contains other helper functions too small to justify their own package NOTE: Subject to change, do not rely on this package from outside git-lfs source
|
Package tools contains other helper functions too small to justify their own package NOTE: Subject to change, do not rely on this package from outside git-lfs source |
|
humanize
package humanize is designed to parse and format "humanized" versions of numbers with units.
|
package humanize is designed to parse and format "humanized" versions of numbers with units. |
|
Package transfer collects together adapters for uploading and downloading LFS content NOTE: Subject to change, do not rely on this package from outside git-lfs source
|
Package transfer collects together adapters for uploading and downloading LFS content NOTE: Subject to change, do not rely on this package from outside git-lfs source |