github.com/psexton/git-lfs@v2.1.1-0.20170517224304-289a18b2bc53+incompatible/docs/man/git-lfs-install.1.ronn (about) 1 git-lfs-install(1) -- Install Git LFS configuration. 2 ======================================================== 3 4 ## SYNOPSIS 5 6 `git lfs install` [options] 7 8 ## DESCRIPTION 9 10 Perform the following actions to ensure that Git LFS is setup properly: 11 12 * Set up the clean and smudge filters under the name "lfs" in the global Git 13 config. 14 * Install a pre-push hook to run git-lfs-pre-push(1) for the current repository, 15 if run from inside one. If "core.hooksPath" is configured in any Git 16 configuration (and supported, i.e., the installed Git version is at least 17 2.9.0), then the pre-push hook will be installed to that directory instead. 18 19 ## OPTIONS 20 21 Without any options, `git lfs install` will only setup the "lfs" smudge and clean 22 filters if they are not already set. 23 24 * `--force`: 25 Sets the "lfs" smudge and clean filters, overwriting existing values. 26 * `--local`: 27 Sets the "lfs" smudge and clean filters in the local repository's git 28 config, instead of the global git config (~/.gitconfig). 29 * `--system`: 30 Sets the "lfs" smudge and clean filters in the system git config, e.g. /etc/gitconfig 31 instead of the global git config (~/.gitconfig). 32 * `--skip-smudge`: 33 Skips automatic downloading of objects on clone or pull. This requires a 34 manual "git lfs pull" every time a new commit is checked out on your 35 repository. 36 * `--skip-repo`: 37 Skips setup of the local repo; use if you want to install the global lfs 38 filters but not make changes to the current repo. 39 40 ## SEE ALSO 41 42 git-lfs-uninstall(1). 43 44 Part of the git-lfs(1) suite.