README.md

   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 By default, the Git LFS client needs a Git LFS server to sync the large files
  24 it manages. This works out of the box when using popular git repository
  25 hosting providers like GitHub, Atlassian, etc. When you host your own
  26 vanilla git server, for example, you need to either use a separate
  27 [Git LFS server instance](https://github.com/git-lfs/git-lfs/wiki/Implementations),
  28 or use the [custom transfer adapter](docs/custom-transfers.md) with
  29 a transfer agent in blind mode, without having to use a Git LFS server instance.
  30
  31 You can install the Git LFS client in several different ways, depending on
  32 your setup and preferences.
  33
  34 * 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.
  35 * 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`.
  36 * Windows users can install from [Chocolatey](https://chocolatey.org/) with `choco install git-lfs`.
  37 * [Binary packages are available][rel] for Windows, Mac, Linux, and FreeBSD.
  38 * You can build it with Go 1.8.1+. See the [Contributing Guide](./CONTRIBUTING.md) for instructions.
  39
  40 [rel]: https://github.com/git-lfs/git-lfs/releases
  41
  42 Note: Git LFS requires Git v1.8.5 or higher.
  43
  44 Once installed, you need to setup the global Git hooks for Git LFS. This only
  45 needs to be done once per machine.
  46
  47 ```bash
  48 $ git lfs install
  49 ```
  50
  51 Now, it's time to add some large files to a repository. The first step is to
  52 specify file patterns to store with Git LFS. These file patterns are stored in
  53 `.gitattributes`.
  54
  55 ```bash
  56 $ mkdir large-repo
  57 $ cd large-repo
  58 $ git init
  59
  60 # Add all zip files through Git LFS
  61 $ git lfs track "*.zip"
  62 ```
  63
  64 Now you're ready to push some commits:
  65
  66 ```bash
  67 $ git add .gitattributes
  68 $ git add my.zip
  69 $ git commit -m "add zip"
  70 ```
  71
  72 You can confirm that Git LFS is managing your zip file:
  73
  74 ```bash
  75 $ git lfs ls-files
  76 my.zip
  77 ```
  78
  79 Once you've made your commits, push your files to the Git remote:
  80
  81 ```bash
  82 $ git push origin master
  83 Sending my.zip
  84 LFS: 12.58 MB / 12.58 MB  100.00 %
  85 Counting objects: 2, done.
  86 Delta compression using up to 8 threads.
  87 Compressing objects: 100% (5/5), done.
  88 Writing objects: 100% (5/5), 548 bytes | 0 bytes/s, done.
  89 Total 5 (delta 1), reused 0 (delta 0)
  90 To https://github.com/git-lfs/git-lfs-test
  91    67fcf6a..47b2002  master -> master
  92 ```
  93
  94 ## Limitations
  95
  96 Git LFS maintains a list of currently known limitations, which you can find and
  97 edit [here](https://github.com/git-lfs/git-lfs/wiki/Limitations).
  98
  99 ## Need Help?
 100
 101 You can get help on specific commands directly:
 102
 103 ```bash
 104 $ git lfs help <subcommand>
 105 ```
 106
 107 The [official documentation](docs) has command references and specifications for
 108 the tool. You can ask questions in the [Git LFS chat room][chat], or [file a new
 109 issue][ish]. Be sure to include details about the problem so we can
 110 troubleshoot it.
 111
 112 1. Include the output of `git lfs env`, which shows how your Git environment
 113 is setup.
 114 2. Include `GIT_TRACE=1` in any bad Git commands to enable debug messages.
 115 3. If the output includes a message like `Errors logged to /path/to/.git/lfs/objects/logs/*.log`,
 116 throw the contents in the issue, or as a link to a Gist or paste site.
 117
 118 [chat]: https://gitter.im/git-lfs/git-lfs
 119 [ish]: https://github.com/git-lfs/git-lfs/issues
 120
 121 ## Contributing
 122
 123 See [CONTRIBUTING.md](CONTRIBUTING.md) for info on working on Git LFS and
 124 sending patches. Related projects are listed on the [Implementations wiki
 125 page][impl]. You can also join [the project's chat room][chat].
 126
 127 [impl]: https://github.com/git-lfs/git-lfs/wiki/Implementations
 128
 129 ### Using LFS from other Go code
 130
 131 At the moment git-lfs is only focussed on the stability of its command line
 132 interface, and the [server APIs](docs/api/README.md). The contents of the
 133 source packages is subject to change. We therefore currently discourage other
 134 Go code from depending on the git-lfs packages directly; an API to be used by
 135 external Go code may be provided in future.
 136
 137 ## Core Team
 138
 139 These are the humans that form the Git LFS core team, which runs the project.
 140
 141 In alphabetical order:
 142
 143 | [@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) |
 144 |---|---|---|---|---|
 145 | [![](https://avatars1.githubusercontent.com/u/7596961?v=3&s=100)](https://github.com/andyneff) | [![](https://avatars1.githubusercontent.com/u/143?v=3&s=100)](https://github.com/rubyist) | [![](https://avatars1.githubusercontent.com/u/142735?v=3&s=100)](https://github.com/sinbad) | [![](https://avatars3.githubusercontent.com/u/21?v=3&s=100)](https://github.com/technoweenie) | [![](https://avatars3.githubusercontent.com/u/443245?v=3&s=100)](https://github.com/ttaylorr) |