github.com/x-oss-byte/git-lfs@v2.5.2+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  * `--manual`:
    30      Print instructions for manually updating your hooks to include git-lfs
    31      functionality. Use this option if `git lfs install` fails because of existing
    32      hooks and you want to retain their functionality.
    33  * `--system`:
    34      Sets the "lfs" smudge and clean filters in the system git config, e.g. /etc/gitconfig
    35      instead of the global git config (~/.gitconfig).
    36  * `--skip-smudge`:
    37      Skips automatic downloading of objects on clone or pull. This requires a
    38      manual "git lfs pull" every time a new commit is checked out on your
    39      repository.
    40  * `--skip-repo`:
    41      Skips setup of the local repo; use if you want to install the global lfs
    42      filters but not make changes to the current repo.
    43  
    44  ## SEE ALSO
    45  
    46  git-lfs-uninstall(1).
    47  
    48  Part of the git-lfs(1) suite.