1GIT-LFS-INSTALL(1)                                          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
19           configured in any Git configuration (and supported, i.e., the
20           installed Git version is at least 2.9.0), then the pre-push hook
21           will be installed to that directory instead.
22

OPTIONS

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

SEE ALSO

68       git-lfs-uninstall(1), git-worktree(1).
69
70       Part of the git-lfs(1) suite.
71
72
73
74                                                            GIT-LFS-INSTALL(1)
Impressum