github.com/psexton/git-lfs@v2.1.1-0.20170517224304-289a18b2bc53+incompatible/README.md (about) 1 # Git Large File Storage 2 3 | Linux | macOS | Windows | 4 | :---- | :------ | :---- | 5 [ ![Linux build status][1]][2] | [![macOS build status][3]][4] | [![Windows build status][5]][6] | 6 7 [1]: https://travis-ci.org/git-lfs/git-lfs.svg?branch=master 8 [2]: https://travis-ci.org/git-lfs/git-lfs 9 [3]: https://circleci.com/gh/git-lfs/git-lfs.svg?style=shield&circle-token=856152c2b02bfd236f54d21e1f581f3e4ebf47ad 10 [4]: https://circleci.com/gh/git-lfs/git-lfs 11 [5]: https://ci.appveyor.com/api/projects/status/46a5yoqc3hk59bl5/branch/master?svg=true 12 [6]: https://ci.appveyor.com/project/git-lfs/git-lfs/branch/master 13 14 Git LFS is a command line extension and [specification](docs/spec.md) for 15 managing large files with Git. The client is written in Go, with pre-compiled 16 binaries available for Mac, Windows, Linux, and FreeBSD. Check out the 17 [Git LFS website][page] for an overview of features. 18 19 [page]: https://git-lfs.github.com/ 20 21 ## Getting Started 22 23 You can install Git LFS in several different ways, depending on your setup and 24 preferences. 25 26 * Linux users can install Debian or RPM packages from [PackageCloud](https://packagecloud.io/github/git-lfs/install). See the [Installation Guide](./INSTALLING.md) for details. 27 * Mac users can install from [Homebrew](https://github.com/Homebrew/homebrew) with `brew install git-lfs`, or from [MacPorts](https://www.macports.org) with `port install git-lfs`. 28 * Windows users can install from [Chocolatey](https://chocolatey.org/) with `choco install git-lfs`. 29 * [Binary packages are available][rel] for Windows, Mac, Linux, and FreeBSD. 30 * You can build it with Go 1.8.1+. See the [Contributing Guide](./CONTRIBUTING.md) for instructions. 31 32 [rel]: https://github.com/git-lfs/git-lfs/releases 33 34 Note: Git LFS requires Git v1.8.5 or higher. 35 36 Once installed, you need to setup the global Git hooks for Git LFS. This only 37 needs to be done once per machine. 38 39 ```bash 40 $ git lfs install 41 ``` 42 43 Now, it's time to add some large files to a repository. The first step is to 44 specify file patterns to store with Git LFS. These file patterns are stored in 45 `.gitattributes`. 46 47 ```bash 48 $ mkdir large-repo 49 $ cd large-repo 50 $ git init 51 52 # Add all zip files through Git LFS 53 $ git lfs track "*.zip" 54 ``` 55 56 Now you're ready to push some commits: 57 58 ```bash 59 $ git add .gitattributes 60 $ git add my.zip 61 $ git commit -m "add zip" 62 ``` 63 64 You can confirm that Git LFS is managing your zip file: 65 66 ```bash 67 $ git lfs ls-files 68 my.zip 69 ``` 70 71 Once you've made your commits, push your files to the Git remote: 72 73 ```bash 74 $ git push origin master 75 Sending my.zip 76 LFS: 12.58 MB / 12.58 MB 100.00 % 77 Counting objects: 2, done. 78 Delta compression using up to 8 threads. 79 Compressing objects: 100% (5/5), done. 80 Writing objects: 100% (5/5), 548 bytes | 0 bytes/s, done. 81 Total 5 (delta 1), reused 0 (delta 0) 82 To https://github.com/git-lfs/git-lfs-test 83 67fcf6a..47b2002 master -> master 84 ``` 85 86 ## Need Help? 87 88 You can get help on specific commands directly: 89 90 ```bash 91 $ git lfs help <subcommand> 92 ``` 93 94 The [official documentation](docs) has command references and specifications for 95 the tool. You can ask questions in the [Git LFS chat room][chat], or [file a new 96 issue][ish]. Be sure to include details about the problem so we can 97 troubleshoot it. 98 99 1. Include the output of `git lfs env`, which shows how your Git environment 100 is setup. 101 2. Include `GIT_TRACE=1` in any bad Git commands to enable debug messages. 102 3. If the output includes a message like `Errors logged to /path/to/.git/lfs/objects/logs/*.log`, 103 throw the contents in the issue, or as a link to a Gist or paste site. 104 105 [chat]: https://gitter.im/git-lfs/git-lfs 106 [ish]: https://github.com/git-lfs/git-lfs/issues 107 108 ## Contributing 109 110 See [CONTRIBUTING.md](CONTRIBUTING.md) for info on working on Git LFS and 111 sending patches. Related projects are listed on the [Implementations wiki 112 page][impl]. You can also join [the project's chat room][chat]. 113 114 [impl]: https://github.com/git-lfs/git-lfs/wiki/Implementations 115 116 ### Using LFS from other Go code 117 118 At the moment git-lfs is only focussed on the stability of its command line 119 interface, and the [server APIs](docs/api/README.md). The contents of the 120 source packages is subject to change. We therefore currently discourage other 121 Go code from depending on the git-lfs packages directly; an API to be used by 122 external Go code may be provided in future. 123 124 ## Core Team 125 126 These are the humans that form the Git LFS core team, which runs the project. 127 128 In alphabetical order: 129 130 | [@andyneff](https://github.com/andyneff) | [@rubyist](https://github.com/rubyist) | [@sinbad](https://github.com/sinbad) | [@technoweenie](https://github.com/technoweenie) | [@ttaylorr](https://github.com/ttaylorr) | 131 |---|---|---|---|---| 132 | [](https://github.com/andyneff) | [](https://github.com/rubyist) | [](https://github.com/sinbad) | [](https://github.com/technoweenie) | [](https://github.com/ttaylorr) |