1GIT-LFS-INSTALL(1)          General Commands Manual         GIT-LFS-INSTALL(1)
2
3
4

NAME

6       git-lfs-install - Install Git LFS configuration.
7

SYNOPSIS

9       git lfs install options
10

DESCRIPTION

12       Perform the following actions to ensure that Git LFS is setup properly:
13
14       ○   Set  up  the  clean  and smudge filters under the name "lfs" in the
15           global Git config.
16
17       ○   Install a pre-push hook to run git-lfs-pre-push(1) for the  current
18           repository,  if run from inside one. If "core.hooksPath" is config‐
19           ured in any Git configuration (and supported, i.e.,  the  installed
20           Git  version is at least 2.9.0), then the pre-push hook will be in‐
21           stalled to that directory instead.
22
23
24

OPTIONS

26       Without any options, git lfs install will only setup the  "lfs"  smudge
27       and clean filters if they are not already set.
28
29       --force
30              Sets  the  "lfs"  smudge and clean filters, overwriting existing
31              values.
32
33       --local
34              Sets the "lfs" smudge and clean filters  in  the  local  reposi‐
35              tory´s  git config, instead of the global git config (~/.gitcon‐
36              fig).
37
38       --worktree
39              Sets the "lfs" smudge and clean filters in the  current  working
40              tree´s  git config, instead of the global git config (~/.gitcon‐
41              fig) or local repository´s git config ($GIT_DIR/config). If mul‐
42              tiple  working  trees are in use, the Git config extension work‐
43              treeConfig must be enabled to use this option. If only one work‐
44              ing  tree  is in use, --worktree has the same effect as --local.
45              This option is only available if the installed Git version is at
46              least  2.20.0 and therefore supports the "worktreeConfig" exten‐
47              sion.
48
49       --manual
50              Print instructions for manually updating your hooks  to  include
51              git-lfs  functionality. Use this option if git lfs install fails
52              because of existing hooks and you want to retain their function‐
53              ality.
54
55       --system
56              Sets  the  "lfs" smudge and clean filters in the system git con‐
57              fig, e.g.  /etc/gitconfig  instead  of  the  global  git  config
58              (~/.gitconfig).
59
60       --skip-smudge
61              Skips  automatic  downloading  of objects on clone or pull. This
62              requires a manual "git lfs pull" every  time  a  new  commit  is
63              checked out on your repository.
64
65       --skip-repo
66              Skips  setup  of  the local repo; use if you want to install the
67              global lfs filters but not make changes to the current repo.
68

SEE ALSO

70       git-lfs-uninstall(1), git-worktree(1).
71
72       Part of the git-lfs(1) suite.
73
74
75
76                                  March 2021                GIT-LFS-INSTALL(1)
Impressum