github.com/saracen/git-lfs@v2.5.2+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](https://git-lfs.github.com) is a command line extension and 15 [specification](docs/spec.md) for managing large files with Git. 16 17 The client is written in Go, with pre-compiled binaries available for Mac, 18 Windows, Linux, and FreeBSD. Check out the [website](http://git-lfs.github.com) 19 for an overview of features. 20 21 ## Getting Started 22 23 ### Installation 24 25 You can install the Git LFS client in several different ways, depending on your 26 setup and preferences. 27 28 * **Linux users**. Debian and RPM packages are available from 29 [PackageCloud](https://packagecloud.io/github/git-lfs/install). 30 * **macOS users**. [Homebrew](https://brew.sh) bottles are distributed, and can 31 be installed via `brew install git-lfs`. 32 * **Windows users**. Git LFS is included in the distribution of 33 [Git for Windows](https://gitforwindows.org/). Alternatively, you can 34 install a recent version of Git LFS from the Chocolatey package manager. 35 36 In addition, [binary packages](https://github.com/git-lfs/git-lfs/releases) are 37 available for Linux, macOS, Windows, and FreeBSD. This repository can also be 38 built from source using the latest version of [Go](https://golang.org), and the 39 available instructions in our 40 [Wiki](https://github.com/git-lfs/git-lfs/wiki/Installation#source). 41 42 ### Usage 43 44 Git LFS requires a global installation once per-machine. This can be done by 45 running: 46 47 ```bash 48 $ git lfs install 49 ``` 50 51 To begin using Git LFS within your Git repository, you can indicate which files 52 you would like Git LFS to manage. This can be done by running the following 53 _from within Git repository_: 54 55 ```bash 56 $ git lfs track "*.psd" 57 ``` 58 59 (Where `*.psd` is the pattern of filenames that you wish to track. You can read 60 more about this pattern syntax 61 [here](https://git-scm.com/docs/gitattributes)). 62 63 After any invocation of `git-lfs-track(1)` or `git-lfs-untrack(1)`, you _must 64 commit changes to your `.gitattributes` file_. This can be done by running: 65 66 ```bash 67 $ git add .gitattributes 68 $ git commit -m "track *.psd files using Git LFS" 69 ``` 70 71 You can now interact with your Git repository as usual, and Git LFS will take 72 care of managing your large files. For example, changing a file named `my.psd` 73 (tracked above via `*.psd`): 74 75 ```bash 76 $ git add my.psd 77 $ git commit -m "add psd" 78 ``` 79 80 > _Tip:_ if you have large files already in your repository's history, `git lfs 81 > track` will _not_ track them retroactively. To migrate existing large files 82 > in your history to use Git LFS, use `git lfs migrate`. For example: 83 > 84 > ``` 85 > $ git lfs migrate import --include="*.psd" 86 > ``` 87 > 88 > For more information, read [`git-lfs-migrate(1)`](https://github.com/git-lfs/git-lfs/blob/master/docs/man/git-lfs-migrate.1.ronn). 89 90 You can confirm that Git LFS is managing your PSD file: 91 92 ```bash 93 $ git lfs ls-files 94 3c2f7aedfb * my.psd 95 ``` 96 97 Once you've made your commits, push your files to the Git remote: 98 99 ```bash 100 $ git push origin master 101 Uploading LFS objects: 100% (1/1), 810 B, 1.2 KB/s 102 # ... 103 To https://github.com/git-lfs/git-lfs-test 104 67fcf6a..47b2002 master -> master 105 ``` 106 107 Note: Git LFS requires Git v1.8.5 or higher. 108 109 ## Limitations 110 111 Git LFS maintains a list of currently known limitations, which you can find and 112 edit [here](https://github.com/git-lfs/git-lfs/wiki/Limitations). 113 114 ## Need Help? 115 116 You can get help on specific commands directly: 117 118 ```bash 119 $ git lfs help <subcommand> 120 ``` 121 122 The [official documentation](docs) has command references and specifications for 123 the tool. 124 125 You can always [open an issue](https://github.com/git-lfs/git-lfs/issues), and 126 one of the Core Team members will respond to you. Please be sure to include: 127 128 1. The output of `git lfs env`, which displays helpful information about your 129 Git repository useful in debugging. 130 2. Any failed commands re-run with `GIT_TRACE=1` in the environment, which 131 displays additional information pertaining to why a command crashed. 132 133 ## Contributing 134 135 See [CONTRIBUTING.md](CONTRIBUTING.md) for info on working on Git LFS and 136 sending patches. Related projects are listed on the [Implementations wiki 137 page](https://github.com/git-lfs/git-lfs/wiki/Implementations). 138 139 ## Core Team 140 141 These are the humans that form the Git LFS core team, which runs the project. 142 143 In alphabetical order: 144 145 | [@larsxschneider][larsxschneider-user] | [@ttaylorr][ttaylorr-user] | 146 |---|---| 147 | [![][larsxschneider-img]][larsxschneider-user] | [![][ttaylorr-img]][ttaylorr-user] | 148 149 [larsxschneider-img]: https://avatars1.githubusercontent.com/u/477434?s=100&v=4 150 [ttaylorr-img]: https://avatars2.githubusercontent.com/u/443245?s=100&v=4 151 [larsxschneider-user]: https://github.com/larsxschneider 152 [ttaylorr-user]: https://github.com/ttaylorr 153 154 ### Alumni 155 156 These are the humans that have in the past formed the Git LFS core team, or 157 have otherwise contributed a significant amount to the project. Git LFS would 158 not be possible without them. 159 160 In alphabetical order: 161 162 | [@andyneff][andyneff-user] | [@rubyist][rubyist-user] | [@sinbad][sinbad-user] | [@technoweenie][technoweenie-user] | 163 |---|---|---|---| 164 | [![][andyneff-img]][andyneff-user] | [![][rubyist-img]][rubyist-user] | [![][sinbad-img]][sinbad-user] | [![][technoweenie-img]][technoweenie-user] | 165 166 [andyneff-img]: https://avatars1.githubusercontent.com/u/7596961?v=3&s=100 167 [rubyist-img]: https://avatars1.githubusercontent.com/u/143?v=3&s=100 168 [sinbad-img]: https://avatars1.githubusercontent.com/u/142735?v=3&s=100 169 [technoweenie-img]: https://avatars3.githubusercontent.com/u/21?v=3&s=100 170 [andyneff-user]: https://github.com/andyneff 171 [sinbad-user]: https://github.com/sinbad 172 [rubyist-user]: https://github.com/rubyist 173 [technoweenie-user]: https://github.com/technoweenie