git-lfs/docs/man/git-lfs-install.1.ronn
2015-11-16 13:37:08 -07:00

37 lines
1.0 KiB
Markdown

git-lfs-install(1) -- Install Git LFS configuration.
========================================================
## SYNOPSIS
`git lfs install` [options]
## DESCRIPTION
Perform the following actions to ensure that Git LFS is setup properly:
* Set up the clean and smudge filters under the name "lfs" in the global Git
config.
* Install a pre-push hook to run git-lfs-pre-push(1) for the current repository,
if run from inside one.
## OPTIONS
Without any options, `git lfs install` will only setup the "lfs" smudge and clean
filters if they are not already set.
* `--force`:
Sets the "lfs" smudge and clean filters, overwriting existing values.
* `--local`:
Sets the "lfs" smudge and clean filters in the local repository's git
config, instead of the global git config.
* `--skip-smudge`:
Skips automatic downloading of objects on clone or pull. This requires a
manual "git lfs pull" every time a new commit is checked out on your
repository.
## SEE ALSO
git-lfs-uninstall(1).
Part of the git-lfs(1) suite.