|
<!DOCTYPE html> |
|
<html> |
|
<head> |
|
<meta http-equiv='content-type' content='text/html;charset=utf8'> |
|
<meta name='generator' content='Ronn-NG/v0.9.1 (http://github.com/apjanke/ronn-ng/tree/0.9.1)'> |
|
<title>git-lfs-install(1) - Install Git LFS configuration.</title> |
|
<style type='text/css' media='all'> |
|
|
|
body#manpage {margin:0} |
|
.mp {max-width:100ex;padding:0 9ex 1ex 4ex} |
|
.mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0} |
|
.mp h2 {margin:10px 0 0 0} |
|
.mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex} |
|
.mp h3 {margin:0 0 0 4ex} |
|
.mp dt {margin:0;clear:left} |
|
.mp dt.flush {float:left;width:8ex} |
|
.mp dd {margin:0 0 0 9ex} |
|
.mp h1,.mp h2,.mp h3,.mp h4 {clear:left} |
|
.mp pre {margin-bottom:20px} |
|
.mp pre+h2,.mp pre+h3 {margin-top:22px} |
|
.mp h2+pre,.mp h3+pre {margin-top:5px} |
|
.mp img {display:block;margin:auto} |
|
.mp h1.man-title {display:none} |
|
.mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143} |
|
.mp h2 {font-size:16px;line-height:1.25} |
|
.mp h1 {font-size:20px;line-height:2} |
|
.mp {text-align:justify;background:#fff} |
|
.mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211} |
|
.mp h1,.mp h2,.mp h3,.mp h4 {color:#030201} |
|
.mp u {text-decoration:underline} |
|
.mp code,.mp strong,.mp b {font-weight:bold;color:#131211} |
|
.mp em,.mp var {font-style:italic;color:#232221;text-decoration:none} |
|
.mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff} |
|
.mp b.man-ref {font-weight:normal;color:#434241} |
|
.mp pre {padding:0 4ex} |
|
.mp pre code {font-weight:normal;color:#434241} |
|
.mp h2+pre,h3+pre {padding-left:0} |
|
ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px} |
|
ol.man-decor {width:100%} |
|
ol.man-decor li.tl {text-align:left} |
|
ol.man-decor li.tc {text-align:center;letter-spacing:4px} |
|
ol.man-decor li.tr {text-align:right;float:right} |
|
</style> |
|
</head> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<body id='manpage'> |
|
<div class='mp' id='man'> |
|
|
|
<div class='man-navigation' style='display:none'> |
|
<a href="#NAME">NAME</a> |
|
<a href="#SYNOPSIS">SYNOPSIS</a> |
|
<a href="#DESCRIPTION">DESCRIPTION</a> |
|
<a href="#OPTIONS">OPTIONS</a> |
|
<a href="#SEE-ALSO">SEE ALSO</a> |
|
</div> |
|
|
|
<ol class='man-decor man-head man head'> |
|
<li class='tl'>git-lfs-install(1)</li> |
|
<li class='tc'></li> |
|
<li class='tr'>git-lfs-install(1)</li> |
|
</ol> |
|
|
|
|
|
|
|
<h2 id="NAME">NAME</h2> |
|
<p class="man-name"> |
|
<code>git-lfs-install</code> - <span class="man-whatis">Install Git LFS configuration.</span> |
|
</p> |
|
<h2 id="SYNOPSIS">SYNOPSIS</h2> |
|
|
|
<p><code>git lfs install</code> <a href="#OPTIONS" title="OPTIONS" data-bare-link="true">options</a></p> |
|
|
|
<h2 id="DESCRIPTION">DESCRIPTION</h2> |
|
|
|
<p>Perform the following actions to ensure that Git LFS is setup properly:</p> |
|
|
|
<ul> |
|
<li>Set up the clean and smudge filters under the name "lfs" in the global Git |
|
config.</li> |
|
<li>Install a pre-push hook to run <a class="man-ref" href="git-lfs-pre-push.1.html">git-lfs-pre-push<span class="s">(1)</span></a> for the current repository, |
|
if run from inside one. If "core.hooksPath" is configured in any Git |
|
configuration (and supported, i.e., the installed Git version is at least |
|
2.9.0), then the pre-push hook will be installed to that directory instead.</li> |
|
</ul> |
|
|
|
<h2 id="OPTIONS">OPTIONS</h2> |
|
|
|
<p>Without any options, <code>git lfs install</code> will only setup the "lfs" smudge and clean |
|
filters if they are not already set.</p> |
|
|
|
<dl> |
|
<dt><code>--force</code></dt> |
|
<dd> Sets the "lfs" smudge and clean filters, overwriting existing values.</dd> |
|
<dt><code>--local</code></dt> |
|
<dd> Sets the "lfs" smudge and clean filters in the local repository's git |
|
config, instead of the global git config (~/.gitconfig).</dd> |
|
<dt><code>--worktree</code></dt> |
|
<dd> Sets the "lfs" smudge and clean filters in the current working tree's |
|
git config, instead of the global git config (~/.gitconfig) or local |
|
repository's git config ($GIT_DIR/config). |
|
If multiple working trees are in use, the Git config extension |
|
<code>worktreeConfig</code> must be enabled to use this option. |
|
If only one working tree is in use, <code>--worktree</code> has the same effect |
|
as <code>--local</code>. |
|
This option is only available if the installed Git version is at least |
|
2.20.0 and therefore supports the "worktreeConfig" extension.</dd> |
|
<dt><code>--manual</code></dt> |
|
<dd> Print instructions for manually updating your hooks to include git-lfs |
|
functionality. Use this option if <code>git lfs install</code> fails because of existing |
|
hooks and you want to retain their functionality.</dd> |
|
<dt><code>--system</code></dt> |
|
<dd> Sets the "lfs" smudge and clean filters in the system git config, e.g. /etc/gitconfig |
|
instead of the global git config (~/.gitconfig).</dd> |
|
<dt><code>--skip-smudge</code></dt> |
|
<dd> 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.</dd> |
|
<dt><code>--skip-repo</code></dt> |
|
<dd> Skips setup of the local repo; use if you want to install the global lfs |
|
filters but not make changes to the current repo.</dd> |
|
</dl> |
|
|
|
<h2 id="SEE-ALSO">SEE ALSO</h2> |
|
|
|
<p><a class="man-ref" href="git-lfs-uninstall.1.html">git-lfs-uninstall<span class="s">(1)</span></a>, <a class="man-ref" href="https://git-scm.com/docs/git-worktree">git-worktree<span class="s">(1)</span></a>.</p> |
|
|
|
<p>Part of the <a class="man-ref" href="git-lfs.1.html">git-lfs<span class="s">(1)</span></a> suite.</p> |
|
|
|
<ol class='man-decor man-foot man foot'> |
|
<li class='tl'></li> |
|
<li class='tc'>May 2022</li> |
|
<li class='tr'>git-lfs-install(1)</li> |
|
</ol> |
|
|
|
</div> |
|
</body> |
|
</html> |
|
|
