git-worktree.html

   1 <!DOCTYPE html>
   2 <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
   3 <head>
   4 <meta charset="UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=edge"/>
   6 <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
   7 <meta name="generator" content="Asciidoctor 2.0.20"/>
   8 <title>git-worktree(1)</title>
   9 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"/>
  10 <style>
  11 /*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
  12 /* Uncomment the following line when using as a custom stylesheet */
  13 /* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */
  14 html{font-family:sans-serif;-webkit-text-size-adjust:100%}
  15 a{background:none}
  16 a:focus{outline:thin dotted}
  17 a:active,a:hover{outline:0}
  18 h1{font-size:2em;margin:.67em 0}
  19 b,strong{font-weight:bold}
  20 abbr{font-size:.9em}
  21 abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
  22 dfn{font-style:italic}
  23 hr{height:0}
  24 mark{background:#ff0;color:#000}
  25 code,kbd,pre,samp{font-family:monospace;font-size:1em}
  26 pre{white-space:pre-wrap}
  27 q{quotes:"\201C" "\201D" "\2018" "\2019"}
  28 small{font-size:80%}
  29 sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
  30 sup{top:-.5em}
  31 sub{bottom:-.25em}
  32 img{border:0}
  33 svg:not(:root){overflow:hidden}
  34 figure{margin:0}
  35 audio,video{display:inline-block}
  36 audio:not([controls]){display:none;height:0}
  37 fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
  38 legend{border:0;padding:0}
  39 button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
  40 button,input{line-height:normal}
  41 button,select{text-transform:none}
  42 button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
  43 button[disabled],html input[disabled]{cursor:default}
  44 input[type=checkbox],input[type=radio]{padding:0}
  45 button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
  46 textarea{overflow:auto;vertical-align:top}
  47 table{border-collapse:collapse;border-spacing:0}
  48 *,::before,::after{box-sizing:border-box}
  49 html,body{font-size:100%}
  50 body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
  51 a:hover{cursor:pointer}
  52 img,object,embed{max-width:100%;height:auto}
  53 object,embed{height:100%}
  54 img{-ms-interpolation-mode:bicubic}
  55 .left{float:left!important}
  56 .right{float:right!important}
  57 .text-left{text-align:left!important}
  58 .text-right{text-align:right!important}
  59 .text-center{text-align:center!important}
  60 .text-justify{text-align:justify!important}
  61 .hide{display:none}
  62 img,object,svg{display:inline-block;vertical-align:middle}
  63 textarea{height:auto;min-height:50px}
  64 select{width:100%}
  65 .subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
  66 div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0}
  67 a{color:#2156a5;text-decoration:underline;line-height:inherit}
  68 a:hover,a:focus{color:#1d4b8f}
  69 a img{border:0}
  70 p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
  71 p aside{font-size:.875em;line-height:1.35;font-style:italic}
  72 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
  73 h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
  74 h1{font-size:2.125em}
  75 h2{font-size:1.6875em}
  76 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
  77 h4,h5{font-size:1.125em}
  78 h6{font-size:1em}
  79 hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
  80 em,i{font-style:italic;line-height:inherit}
  81 strong,b{font-weight:bold;line-height:inherit}
  82 small{font-size:60%;line-height:inherit}
  83 code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
  84 ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
  85 ul,ol{margin-left:1.5em}
  86 ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
  87 ul.circle{list-style-type:circle}
  88 ul.disc{list-style-type:disc}
  89 ul.square{list-style-type:square}
  90 ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
  91 ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
  92 dl dt{margin-bottom:.3125em;font-weight:bold}
  93 dl dd{margin-bottom:1.25em}
  94 blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
  95 blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
  96 @media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
  97 h1{font-size:2.75em}
  98 h2{font-size:2.3125em}
  99 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
 100 h4{font-size:1.4375em}}
 101 table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
 102 table thead,table tfoot{background:#f7f8f7}
 103 table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
 104 table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
 105 table tr.even,table tr.alt{background:#f8f8f7}
 106 table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
 107 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
 108 h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
 109 .center{margin-left:auto;margin-right:auto}
 110 .stretch{width:100%}
 111 .clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
 112 .clearfix::after,.float-group::after{clear:both}
 113 :not(pre).nobreak{word-wrap:normal}
 114 :not(pre).nowrap{white-space:nowrap}
 115 :not(pre).pre-wrap{white-space:pre-wrap}
 116 :not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
 117 pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
 118 pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
 119 pre>code{display:block}
 120 pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
 121 em em{font-style:normal}
 122 strong strong{font-weight:400}
 123 .keyseq{color:rgba(51,51,51,.8)}
 124 kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
 125 .keyseq kbd:first-child{margin-left:0}
 126 .keyseq kbd:last-child{margin-right:0}
 127 .menuseq,.menuref{color:#000}
 128 .menuseq b:not(.caret),.menuref{font-weight:inherit}
 129 .menuseq{word-spacing:-.02em}
 130 .menuseq b.caret{font-size:1.25em;line-height:.8}
 131 .menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
 132 b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
 133 b.button::before{content:"[";padding:0 3px 0 2px}
 134 b.button::after{content:"]";padding:0 2px 0 3px}
 135 p a>code:hover{color:rgba(0,0,0,.9)}
 136 #header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
 137 #header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
 138 #header::after,#content::after,#footnotes::after,#footer::after{clear:both}
 139 #content{margin-top:1.25em}
 140 #content::before{content:none}
 141 #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
 142 #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
 143 #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
 144 #header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap}
 145 #header .details span:first-child{margin-left:-.125em}
 146 #header .details span.email a{color:rgba(0,0,0,.85)}
 147 #header .details br{display:none}
 148 #header .details br+span::before{content:"\00a0\2013\00a0"}
 149 #header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
 150 #header .details br+span#revremark::before{content:"\00a0|\00a0"}
 151 #header #revnumber{text-transform:capitalize}
 152 #header #revnumber::after{content:"\00a0"}
 153 #content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
 154 #toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
 155 #toc>ul{margin-left:.125em}
 156 #toc ul.sectlevel0>li>a{font-style:italic}
 157 #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
 158 #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
 159 #toc li{line-height:1.3334;margin-top:.3334em}
 160 #toc a{text-decoration:none}
 161 #toc a:active{text-decoration:underline}
 162 #toctitle{color:#7a2518;font-size:1.2em}
 163 @media screen and (min-width:768px){#toctitle{font-size:1.375em}
 164 body.toc2{padding-left:15em;padding-right:0}
 165 #toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
 166 #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
 167 #toc.toc2>ul{font-size:.9em;margin-bottom:0}
 168 #toc.toc2 ul ul{margin-left:0;padding-left:1em}
 169 #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
 170 body.toc2.toc-right{padding-left:0;padding-right:15em}
 171 body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
 172 @media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
 173 #toc.toc2{width:20em}
 174 #toc.toc2 #toctitle{font-size:1.375em}
 175 #toc.toc2>ul{font-size:.95em}
 176 #toc.toc2 ul ul{padding-left:1.25em}
 177 body.toc2.toc-right{padding-left:0;padding-right:20em}}
 178 #content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
 179 #content #toc>:first-child{margin-top:0}
 180 #content #toc>:last-child{margin-bottom:0}
 181 #footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
 182 #footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
 183 #content{margin-bottom:.625em}
 184 .sect1{padding-bottom:.625em}
 185 @media screen and (min-width:768px){#content{margin-bottom:1.25em}
 186 .sect1{padding-bottom:1.25em}}
 187 .sect1:last-child{padding-bottom:0}
 188 .sect1+.sect1{border-top:1px solid #e7e7e9}
 189 #content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
 190 #content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
 191 #content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
 192 #content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
 193 #content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
 194 details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
 195 details{margin-left:1.25rem}
 196 details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
 197 details>summary::-webkit-details-marker{display:none}
 198 details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)}
 199 details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
 200 details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
 201 .admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
 202 table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
 203 .paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
 204 .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
 205 .admonitionblock>table td.icon{text-align:center;width:80px}
 206 .admonitionblock>table td.icon img{max-width:none}
 207 .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
 208 .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere}
 209 .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
 210 .exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
 211 .sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
 212 .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
 213 .exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
 214 .exampleblock>.content>:last-child,.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
 215 .literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
 216 @media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
 217 @media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
 218 .literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
 219 .literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
 220 .listingblock>.content{position:relative}
 221 .listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
 222 .listingblock:hover code[data-lang]::before{display:block}
 223 .listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
 224 .listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
 225 .listingblock pre.highlightjs{padding:0}
 226 .listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
 227 .listingblock pre.prettyprint{border-width:0}
 228 .prettyprint{background:#f7f7f8}
 229 pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
 230 pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
 231 pre.prettyprint li code[data-lang]::before{opacity:1}
 232 pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
 233 table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
 234 table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
 235 table.linenotable td.code{padding-left:.75em}
 236 table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
 237 pre.pygments span.linenos{display:inline-block;margin-right:.75em}
 238 .quoteblock{margin:0 1em 1.25em 1.5em;display:table}
 239 .quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
 240 .quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
 241 .quoteblock blockquote{margin:0;padding:0;border:0}
 242 .quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
 243 .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
 244 .quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
 245 .verseblock{margin:0 1em 1.25em}
 246 .verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
 247 .verseblock pre strong{font-weight:400}
 248 .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
 249 .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
 250 .quoteblock .attribution br,.verseblock .attribution br{display:none}
 251 .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
 252 .quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
 253 .quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
 254 .quoteblock.abstract{margin:0 1em 1.25em;display:block}
 255 .quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
 256 .quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
 257 .quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
 258 .quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
 259 .quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
 260 p.tableblock:last-child{margin-bottom:0}
 261 td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
 262 td.tableblock>.content>:last-child{margin-bottom:-1.25em}
 263 table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
 264 table.grid-all>*>tr>*{border-width:1px}
 265 table.grid-cols>*>tr>*{border-width:0 1px}
 266 table.grid-rows>*>tr>*{border-width:1px 0}
 267 table.frame-all{border-width:1px}
 268 table.frame-ends{border-width:1px 0}
 269 table.frame-sides{border-width:0 1px}
 270 table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
 271 table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
 272 table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
 273 table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
 274 table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7}
 275 th.halign-left,td.halign-left{text-align:left}
 276 th.halign-right,td.halign-right{text-align:right}
 277 th.halign-center,td.halign-center{text-align:center}
 278 th.valign-top,td.valign-top{vertical-align:top}
 279 th.valign-bottom,td.valign-bottom{vertical-align:bottom}
 280 th.valign-middle,td.valign-middle{vertical-align:middle}
 281 table thead th,table tfoot th{font-weight:bold}
 282 tbody tr th{background:#f7f8f7}
 283 tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
 284 p.tableblock>code:only-child{background:none;padding:0}
 285 p.tableblock{font-size:1em}
 286 ol{margin-left:1.75em}
 287 ul li ol{margin-left:1.5em}
 288 dl dd{margin-left:1.125em}
 289 dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
 290 li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
 291 ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
 292 ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
 293 ul.unstyled,ol.unstyled{margin-left:0}
 294 li>p:empty:only-child::before{content:"";display:inline-block}
 295 ul.checklist>li>p:first-child{margin-left:-1em}
 296 ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
 297 ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
 298 ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
 299 ul.inline>li{margin-left:1.25em}
 300 .unstyled dl dt{font-weight:400;font-style:normal}
 301 ol.arabic{list-style-type:decimal}
 302 ol.decimal{list-style-type:decimal-leading-zero}
 303 ol.loweralpha{list-style-type:lower-alpha}
 304 ol.upperalpha{list-style-type:upper-alpha}
 305 ol.lowerroman{list-style-type:lower-roman}
 306 ol.upperroman{list-style-type:upper-roman}
 307 ol.lowergreek{list-style-type:lower-greek}
 308 .hdlist>table,.colist>table{border:0;background:none}
 309 .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
 310 td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
 311 td.hdlist1{font-weight:bold;padding-bottom:1.25em}
 312 td.hdlist2{word-wrap:anywhere}
 313 .literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
 314 .colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
 315 .colist td:not([class]):first-child img{max-width:none}
 316 .colist td:not([class]):last-child{padding:.25em 0}
 317 .thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
 318 .imageblock.left{margin:.25em .625em 1.25em 0}
 319 .imageblock.right{margin:.25em 0 1.25em .625em}
 320 .imageblock>.title{margin-bottom:0}
 321 .imageblock.thumb,.imageblock.th{border-width:6px}
 322 .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
 323 .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
 324 .image.left{margin-right:.625em}
 325 .image.right{margin-left:.625em}
 326 a.image{text-decoration:none;display:inline-block}
 327 a.image object{pointer-events:none}
 328 sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
 329 sup.footnote a,sup.footnoteref a{text-decoration:none}
 330 sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
 331 #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
 332 #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
 333 #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
 334 #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
 335 #footnotes .footnote:last-of-type{margin-bottom:0}
 336 #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
 337 div.unbreakable{page-break-inside:avoid}
 338 .big{font-size:larger}
 339 .small{font-size:smaller}
 340 .underline{text-decoration:underline}
 341 .overline{text-decoration:overline}
 342 .line-through{text-decoration:line-through}
 343 .aqua{color:#00bfbf}
 344 .aqua-background{background:#00fafa}
 345 .black{color:#000}
 346 .black-background{background:#000}
 347 .blue{color:#0000bf}
 348 .blue-background{background:#0000fa}
 349 .fuchsia{color:#bf00bf}
 350 .fuchsia-background{background:#fa00fa}
 351 .gray{color:#606060}
 352 .gray-background{background:#7d7d7d}
 353 .green{color:#006000}
 354 .green-background{background:#007d00}
 355 .lime{color:#00bf00}
 356 .lime-background{background:#00fa00}
 357 .maroon{color:#600000}
 358 .maroon-background{background:#7d0000}
 359 .navy{color:#000060}
 360 .navy-background{background:#00007d}
 361 .olive{color:#606000}
 362 .olive-background{background:#7d7d00}
 363 .purple{color:#600060}
 364 .purple-background{background:#7d007d}
 365 .red{color:#bf0000}
 366 .red-background{background:#fa0000}
 367 .silver{color:#909090}
 368 .silver-background{background:#bcbcbc}
 369 .teal{color:#006060}
 370 .teal-background{background:#007d7d}
 371 .white{color:#bfbfbf}
 372 .white-background{background:#fafafa}
 373 .yellow{color:#bfbf00}
 374 .yellow-background{background:#fafa00}
 375 span.icon>.fa{cursor:default}
 376 a span.icon>.fa{cursor:inherit}
 377 .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
 378 .admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
 379 .admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
 380 .admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
 381 .admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
 382 .admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
 383 .conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
 384 .conum[data-value] *{color:#fff!important}
 385 .conum[data-value]+b{display:none}
 386 .conum[data-value]::after{content:attr(data-value)}
 387 pre .conum[data-value]{position:relative;top:-.125em}
 388 b.conum *{color:inherit!important}
 389 .conum:not([data-value]):empty{display:none}
 390 dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
 391 h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
 392 p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
 393 p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
 394 p{margin-bottom:1.25rem}
 395 .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
 396 .exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
 397 .print-only{display:none!important}
 398 @page{margin:1.25cm .75cm}
 399 @media print{*{box-shadow:none!important;text-shadow:none!important}
 400 html{font-size:80%}
 401 a{color:inherit!important;text-decoration:underline!important}
 402 a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
 403 a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
 404 abbr[title]{border-bottom:1px dotted}
 405 abbr[title]::after{content:" (" attr(title) ")"}
 406 pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
 407 thead{display:table-header-group}
 408 svg{max-width:100%}
 409 p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
 410 h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
 411 #header,#content,#footnotes,#footer{max-width:none}
 412 #toc,.sidebarblock,.exampleblock>.content{background:none!important}
 413 #toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
 414 body.book #header{text-align:center}
 415 body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
 416 body.book #header .details{border:0!important;display:block;padding:0!important}
 417 body.book #header .details span:first-child{margin-left:0!important}
 418 body.book #header .details br{display:block}
 419 body.book #header .details br+span::before{content:none!important}
 420 body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
 421 body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
 422 .listingblock code[data-lang]::before{display:block}
 423 #footer{padding:0 .9375em}
 424 .hide-on-print{display:none!important}
 425 .print-only{display:block!important}
 426 .hide-for-print{display:none!important}
 427 .show-for-print{display:inherit!important}}
 428 @media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
 429 .sect1{padding:0!important}
 430 .sect1+.sect1{border:0}
 431 #footer{background:none}
 432 #footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
 433 @media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
 434 </style>
 435 <style>
 436 pre>code {
 437    display: inline;
 438 }
 439 </style>
 440 </head>
 441 <body class="manpage">
 442 <div id="header">
 443 <h1>git-worktree(1) Manual Page</h1>
 444 <h2 id="_name">NAME</h2>
 445 <div class="sectionbody">
 446 <p>git-worktree - Manage multiple working trees</p>
 447 </div>
 448 </div>
 449 <div id="content">
 450 <div class="sect1">
 451 <h2 id="_synopsis">SYNOPSIS</h2>
 452 <div class="sectionbody">
 453 <div class="verseblock">
 454 <pre class="content"><em>git worktree add</em> [-f] [--detach] [--checkout] [--lock [--reason &lt;string&gt;]]
 455                    [--orphan] [(-b | -B) &lt;new-branch&gt;] &lt;path&gt; [&lt;commit-ish&gt;]
 456 <em>git worktree list</em> [-v | --porcelain [-z]]
 457 <em>git worktree lock</em> [--reason &lt;string&gt;] &lt;worktree&gt;
 458 <em>git worktree move</em> &lt;worktree&gt; &lt;new-path&gt;
 459 <em>git worktree prune</em> [-n] [-v] [--expire &lt;expire&gt;]
 460 <em>git worktree remove</em> [-f] &lt;worktree&gt;
 461 <em>git worktree repair</em> [&lt;path&gt;&#8230;&#8203;]
 462 <em>git worktree unlock</em> &lt;worktree&gt;</pre>
 463 </div>
 464 </div>
 465 </div>
 466 <div class="sect1">
 467 <h2 id="_description">DESCRIPTION</h2>
 468 <div class="sectionbody">
 469 <div class="paragraph">
 470 <p>Manage multiple working trees attached to the same repository.</p>
 471 </div>
 472 <div class="paragraph">
 473 <p>A git repository can support multiple working trees, allowing you to check
 474 out more than one branch at a time.  With <code>git worktree add</code> a new working
 475 tree is associated with the repository, along with additional metadata
 476 that differentiates that working tree from others in the same repository.
 477 The working tree, along with this metadata, is called a "worktree".</p>
 478 </div>
 479 <div class="paragraph">
 480 <p>This new worktree is called a "linked worktree" as opposed to the "main
 481 worktree" prepared by <a href="git-init.html">git-init(1)</a> or <a href="git-clone.html">git-clone(1)</a>.
 482 A repository has one main worktree (if it&#8217;s not a bare repository) and
 483 zero or more linked worktrees. When you are done with a linked worktree,
 484 remove it with <code>git worktree remove</code>.</p>
 485 </div>
 486 <div class="paragraph">
 487 <p>In its simplest form, <code>git worktree add &lt;path&gt;</code> automatically creates a
 488 new branch whose name is the final component of <code>&lt;path&gt;</code>, which is
 489 convenient if you plan to work on a new topic. For instance, <code>git
 490 worktree add ../hotfix</code> creates new branch <code>hotfix</code> and checks it out at
 491 path <code>../hotfix</code>. To instead work on an existing branch in a new worktree,
 492 use <code>git worktree add &lt;path&gt; &lt;branch&gt;</code>. On the other hand, if you just
 493 plan to make some experimental changes or do testing without disturbing
 494 existing development, it is often convenient to create a <em>throwaway</em>
 495 worktree not associated with any branch. For instance,
 496 <code>git worktree add -d &lt;path&gt;</code> creates a new worktree with a detached <code>HEAD</code>
 497 at the same commit as the current branch.</p>
 498 </div>
 499 <div class="paragraph">
 500 <p>If a working tree is deleted without using <code>git worktree remove</code>, then
 501 its associated administrative files, which reside in the repository
 502 (see "DETAILS" below), will eventually be removed automatically (see
 503 <code>gc.worktreePruneExpire</code> in <a href="git-config.html">git-config(1)</a>), or you can run
 504 <code>git worktree prune</code> in the main or any linked worktree to clean up any
 505 stale administrative files.</p>
 506 </div>
 507 <div class="paragraph">
 508 <p>If the working tree for a linked worktree is stored on a portable device
 509 or network share which is not always mounted, you can prevent its
 510 administrative files from being pruned by issuing the <code>git worktree lock</code>
 511 command, optionally specifying <code>--reason</code> to explain why the worktree is
 512 locked.</p>
 513 </div>
 514 </div>
 515 </div>
 516 <div class="sect1">
 517 <h2 id="_commands">COMMANDS</h2>
 518 <div class="sectionbody">
 519 <div class="dlist">
 520 <dl>
 521 <dt class="hdlist1">add &lt;path&gt; [&lt;commit-ish&gt;]</dt>
 522 <dd>
 523 <p>Create a worktree at <code>&lt;path&gt;</code> and checkout <code>&lt;commit-ish&gt;</code> into it. The new worktree
 524 is linked to the current repository, sharing everything except per-worktree
 525 files such as <code>HEAD</code>, <code>index</code>, etc. As a convenience, <code>&lt;commit-ish&gt;</code> may
 526 be a bare "<code>-</code>", which is synonymous with <code>@{-1}</code>.</p>
 527 <div class="paragraph">
 528 <p>If <code>&lt;commit-ish&gt;</code> is a branch name (call it <code>&lt;branch&gt;</code>) and is not found,
 529 and neither <code>-b</code> nor <code>-B</code> nor <code>--detach</code> are used, but there does
 530 exist a tracking branch in exactly one remote (call it <code>&lt;remote&gt;</code>)
 531 with a matching name, treat as equivalent to:</p>
 532 </div>
 533 <div class="listingblock">
 534 <div class="content">
 535 <pre>$ git worktree add --track -b &lt;branch&gt; &lt;path&gt; &lt;remote&gt;/&lt;branch&gt;</pre>
 536 </div>
 537 </div>
 538 <div class="paragraph">
 539 <p>If the branch exists in multiple remotes and one of them is named by
 540 the <code>checkout.defaultRemote</code> configuration variable, we&#8217;ll use that
 541 one for the purposes of disambiguation, even if the <code>&lt;branch&gt;</code> isn&#8217;t
 542 unique across all remotes. Set it to
 543 e.g. <code>checkout.defaultRemote=origin</code> to always checkout remote
 544 branches from there if <code>&lt;branch&gt;</code> is ambiguous but exists on the
 545 <code>origin</code> remote. See also <code>checkout.defaultRemote</code> in
 546 <a href="git-config.html">git-config(1)</a>.</p>
 547 </div>
 548 <div class="paragraph">
 549 <p>If <code>&lt;commit-ish&gt;</code> is omitted and neither <code>-b</code> nor <code>-B</code> nor <code>--detach</code> used,
 550 then, as a convenience, the new worktree is associated with a branch (call
 551 it <code>&lt;branch&gt;</code>) named after <code>$(basename &lt;path&gt;)</code>.  If <code>&lt;branch&gt;</code> doesn&#8217;t
 552 exist, a new branch based on <code>HEAD</code> is automatically created as if
 553 <code>-b &lt;branch&gt;</code> was given.  If <code>&lt;branch&gt;</code> does exist, it will be checked out
 554 in the new worktree, if it&#8217;s not checked out anywhere else, otherwise the
 555 command will refuse to create the worktree (unless <code>--force</code> is used).</p>
 556 </div>
 557 <div class="paragraph">
 558 <p>If <code>&lt;commit-ish&gt;</code> is omitted, neither <code>--detach</code>, or <code>--orphan</code> is
 559 used, and there are no valid local branches (or remote branches if
 560 <code>--guess-remote</code> is specified) then, as a convenience, the new worktree is
 561 associated with a new unborn branch named <code>&lt;branch&gt;</code> (after
 562 <code>$(basename &lt;path&gt;)</code> if neither <code>-b</code> or <code>-B</code> is used) as if <code>--orphan</code> was
 563 passed to the command. In the event the repository has a remote and
 564 <code>--guess-remote</code> is used, but no remote or local branches exist, then the
 565 command fails with a warning reminding the user to fetch from their remote
 566 first (or override by using <code>-f/--force</code>).</p>
 567 </div>
 568 </dd>
 569 <dt class="hdlist1">list</dt>
 570 <dd>
 571 <p>List details of each worktree.  The main worktree is listed first,
 572 followed by each of the linked worktrees.  The output details include
 573 whether the worktree is bare, the revision currently checked out, the
 574 branch currently checked out (or "detached HEAD" if none), "locked" if
 575 the worktree is locked, "prunable" if the worktree can be pruned by the
 576 <code>prune</code> command.</p>
 577 </dd>
 578 <dt class="hdlist1">lock</dt>
 579 <dd>
 580 <p>If a worktree is on a portable device or network share which is not always
 581 mounted, lock it to prevent its administrative files from being pruned
 582 automatically. This also prevents it from being moved or deleted.
 583 Optionally, specify a reason for the lock with <code>--reason</code>.</p>
 584 </dd>
 585 <dt class="hdlist1">move</dt>
 586 <dd>
 587 <p>Move a worktree to a new location. Note that the main worktree or linked
 588 worktrees containing submodules cannot be moved with this command. (The
 589 <code>git worktree repair</code> command, however, can reestablish the connection
 590 with linked worktrees if you move the main worktree manually.)</p>
 591 </dd>
 592 <dt class="hdlist1">prune</dt>
 593 <dd>
 594 <p>Prune worktree information in <code>$GIT_DIR/worktrees</code>.</p>
 595 </dd>
 596 <dt class="hdlist1">remove</dt>
 597 <dd>
 598 <p>Remove a worktree. Only clean worktrees (no untracked files and no
 599 modification in tracked files) can be removed. Unclean worktrees or ones
 600 with submodules can be removed with <code>--force</code>. The main worktree cannot be
 601 removed.</p>
 602 </dd>
 603 <dt class="hdlist1">repair [&lt;path&gt;&#8230;&#8203;]</dt>
 604 <dd>
 605 <p>Repair worktree administrative files, if possible, if they have become
 606 corrupted or outdated due to external factors.</p>
 607 <div class="paragraph">
 608 <p>For instance, if the main worktree (or bare repository) is moved, linked
 609 worktrees will be unable to locate it. Running <code>repair</code> in the main
 610 worktree will reestablish the connection from linked worktrees back to the
 611 main worktree.</p>
 612 </div>
 613 <div class="paragraph">
 614 <p>Similarly, if the working tree for a linked worktree is moved without
 615 using <code>git worktree move</code>, the main worktree (or bare repository) will be
 616 unable to locate it. Running <code>repair</code> within the recently-moved worktree
 617 will reestablish the connection. If multiple linked worktrees are moved,
 618 running <code>repair</code> from any worktree with each tree&#8217;s new <code>&lt;path&gt;</code> as an
 619 argument, will reestablish the connection to all the specified paths.</p>
 620 </div>
 621 <div class="paragraph">
 622 <p>If both the main worktree and linked worktrees have been moved manually,
 623 then running <code>repair</code> in the main worktree and specifying the new <code>&lt;path&gt;</code>
 624 of each linked worktree will reestablish all connections in both
 625 directions.</p>
 626 </div>
 627 </dd>
 628 <dt class="hdlist1">unlock</dt>
 629 <dd>
 630 <p>Unlock a worktree, allowing it to be pruned, moved or deleted.</p>
 631 </dd>
 632 </dl>
 633 </div>
 634 </div>
 635 </div>
 636 <div class="sect1">
 637 <h2 id="_options">OPTIONS</h2>
 638 <div class="sectionbody">
 639 <div class="dlist">
 640 <dl>
 641 <dt class="hdlist1">-f</dt>
 642 <dt class="hdlist1">--force</dt>
 643 <dd>
 644 <p>By default, <code>add</code> refuses to create a new worktree when
 645 <code>&lt;commit-ish&gt;</code> is a branch name and is already checked out by
 646 another worktree, or if <code>&lt;path&gt;</code> is already assigned to some
 647 worktree but is missing (for instance, if <code>&lt;path&gt;</code> was deleted
 648 manually). This option overrides these safeguards. To add a missing but
 649 locked worktree path, specify <code>--force</code> twice.</p>
 650 <div class="paragraph">
 651 <p><code>move</code> refuses to move a locked worktree unless <code>--force</code> is specified
 652 twice. If the destination is already assigned to some other worktree but is
 653 missing (for instance, if <code>&lt;new-path&gt;</code> was deleted manually), then <code>--force</code>
 654 allows the move to proceed; use <code>--force</code> twice if the destination is locked.</p>
 655 </div>
 656 <div class="paragraph">
 657 <p><code>remove</code> refuses to remove an unclean worktree unless <code>--force</code> is used.
 658 To remove a locked worktree, specify <code>--force</code> twice.</p>
 659 </div>
 660 </dd>
 661 <dt class="hdlist1">-b &lt;new-branch&gt;</dt>
 662 <dt class="hdlist1">-B &lt;new-branch&gt;</dt>
 663 <dd>
 664 <p>With <code>add</code>, create a new branch named <code>&lt;new-branch&gt;</code> starting at
 665 <code>&lt;commit-ish&gt;</code>, and check out <code>&lt;new-branch&gt;</code> into the new worktree.
 666 If <code>&lt;commit-ish&gt;</code> is omitted, it defaults to <code>HEAD</code>.
 667 By default, <code>-b</code> refuses to create a new branch if it already
 668 exists. <code>-B</code> overrides this safeguard, resetting <code>&lt;new-branch&gt;</code> to
 669 <code>&lt;commit-ish&gt;</code>.</p>
 670 </dd>
 671 <dt class="hdlist1">-d</dt>
 672 <dt class="hdlist1">--detach</dt>
 673 <dd>
 674 <p>With <code>add</code>, detach <code>HEAD</code> in the new worktree. See "DETACHED HEAD"
 675 in <a href="git-checkout.html">git-checkout(1)</a>.</p>
 676 </dd>
 677 <dt class="hdlist1">--[no-]checkout</dt>
 678 <dd>
 679 <p>By default, <code>add</code> checks out <code>&lt;commit-ish&gt;</code>, however, <code>--no-checkout</code> can
 680 be used to suppress checkout in order to make customizations,
 681 such as configuring sparse-checkout. See "Sparse checkout"
 682 in <a href="git-read-tree.html">git-read-tree(1)</a>.</p>
 683 </dd>
 684 <dt class="hdlist1">--[no-]guess-remote</dt>
 685 <dd>
 686 <p>With <code>worktree add &lt;path&gt;</code>, without <code>&lt;commit-ish&gt;</code>, instead
 687 of creating a new branch from <code>HEAD</code>, if there exists a tracking
 688 branch in exactly one remote matching the basename of <code>&lt;path&gt;</code>,
 689 base the new branch on the remote-tracking branch, and mark
 690 the remote-tracking branch as "upstream" from the new branch.</p>
 691 <div class="paragraph">
 692 <p>This can also be set up as the default behaviour by using the
 693 <code>worktree.guessRemote</code> config option.</p>
 694 </div>
 695 </dd>
 696 <dt class="hdlist1">--[no-]track</dt>
 697 <dd>
 698 <p>When creating a new branch, if <code>&lt;commit-ish&gt;</code> is a branch,
 699 mark it as "upstream" from the new branch.  This is the
 700 default if <code>&lt;commit-ish&gt;</code> is a remote-tracking branch.  See
 701 <code>--track</code> in <a href="git-branch.html">git-branch(1)</a> for details.</p>
 702 </dd>
 703 <dt class="hdlist1">--lock</dt>
 704 <dd>
 705 <p>Keep the worktree locked after creation. This is the
 706 equivalent of <code>git worktree lock</code> after <code>git worktree add</code>,
 707 but without a race condition.</p>
 708 </dd>
 709 <dt class="hdlist1">-n</dt>
 710 <dt class="hdlist1">--dry-run</dt>
 711 <dd>
 712 <p>With <code>prune</code>, do not remove anything; just report what it would
 713 remove.</p>
 714 </dd>
 715 <dt class="hdlist1">--orphan</dt>
 716 <dd>
 717 <p>With <code>add</code>, make the new worktree and index empty, associating
 718 the worktree with a new unborn branch named <code>&lt;new-branch&gt;</code>.</p>
 719 </dd>
 720 <dt class="hdlist1">--porcelain</dt>
 721 <dd>
 722 <p>With <code>list</code>, output in an easy-to-parse format for scripts.
 723 This format will remain stable across Git versions and regardless of user
 724 configuration.  It is recommended to combine this with <code>-z</code>.
 725 See below for details.</p>
 726 </dd>
 727 <dt class="hdlist1">-z</dt>
 728 <dd>
 729 <p>Terminate each line with a NUL rather than a newline when
 730 <code>--porcelain</code> is specified with <code>list</code>. This makes it possible
 731 to parse the output when a worktree path contains a newline
 732 character.</p>
 733 </dd>
 734 <dt class="hdlist1">-q</dt>
 735 <dt class="hdlist1">--quiet</dt>
 736 <dd>
 737 <p>With <code>add</code>, suppress feedback messages.</p>
 738 </dd>
 739 <dt class="hdlist1">-v</dt>
 740 <dt class="hdlist1">--verbose</dt>
 741 <dd>
 742 <p>With <code>prune</code>, report all removals.</p>
 743 <div class="paragraph">
 744 <p>With <code>list</code>, output additional information about worktrees (see below).</p>
 745 </div>
 746 </dd>
 747 <dt class="hdlist1">--expire &lt;time&gt;</dt>
 748 <dd>
 749 <p>With <code>prune</code>, only expire unused worktrees older than <code>&lt;time&gt;</code>.</p>
 750 <div class="paragraph">
 751 <p>With <code>list</code>, annotate missing worktrees as prunable if they are older than
 752 <code>&lt;time&gt;</code>.</p>
 753 </div>
 754 </dd>
 755 <dt class="hdlist1">--reason &lt;string&gt;</dt>
 756 <dd>
 757 <p>With <code>lock</code> or with <code>add --lock</code>, an explanation why the worktree
 758 is locked.</p>
 759 </dd>
 760 <dt class="hdlist1">&lt;worktree&gt;</dt>
 761 <dd>
 762 <p>Worktrees can be identified by path, either relative or absolute.</p>
 763 <div class="paragraph">
 764 <p>If the last path components in the worktree&#8217;s path is unique among
 765 worktrees, it can be used to identify a worktree. For example if you only
 766 have two worktrees, at <code>/abc/def/ghi</code> and <code>/abc/def/ggg</code>, then <code>ghi</code> or
 767 <code>def/ghi</code> is enough to point to the former worktree.</p>
 768 </div>
 769 </dd>
 770 </dl>
 771 </div>
 772 </div>
 773 </div>
 774 <div class="sect1">
 775 <h2 id="_refs">REFS</h2>
 776 <div class="sectionbody">
 777 <div class="paragraph">
 778 <p>When using multiple worktrees, some refs are shared between all worktrees,
 779 but others are specific to an individual worktree. One example is <code>HEAD</code>,
 780 which is different for each worktree. This section is about the sharing
 781 rules and how to access refs of one worktree from another.</p>
 782 </div>
 783 <div class="paragraph">
 784 <p>In general, all pseudo refs are per-worktree and all refs starting with
 785 <code>refs/</code> are shared. Pseudo refs are ones like <code>HEAD</code> which are directly
 786 under <code>$GIT_DIR</code> instead of inside <code>$GIT_DIR/refs</code>. There are exceptions,
 787 however: refs inside <code>refs/bisect</code>, <code>refs/worktree</code> and <code>refs/rewritten</code> are
 788 not shared.</p>
 789 </div>
 790 <div class="paragraph">
 791 <p>Refs that are per-worktree can still be accessed from another worktree via
 792 two special paths, <code>main-worktree</code> and <code>worktrees</code>. The former gives
 793 access to per-worktree refs of the main worktree, while the latter to all
 794 linked worktrees.</p>
 795 </div>
 796 <div class="paragraph">
 797 <p>For example, <code>main-worktree/HEAD</code> or <code>main-worktree/refs/bisect/good</code>
 798 resolve to the same value as the main worktree&#8217;s <code>HEAD</code> and
 799 <code>refs/bisect/good</code> respectively. Similarly, <code>worktrees/foo/HEAD</code> or
 800 <code>worktrees/bar/refs/bisect/bad</code> are the same as
 801 <code>$GIT_COMMON_DIR/worktrees/foo/HEAD</code> and
 802 <code>$GIT_COMMON_DIR/worktrees/bar/refs/bisect/bad</code>.</p>
 803 </div>
 804 <div class="paragraph">
 805 <p>To access refs, it&#8217;s best not to look inside <code>$GIT_DIR</code> directly. Instead
 806 use commands such as <a href="git-rev-parse.html">git-rev-parse(1)</a> or <a href="git-update-ref.html">git-update-ref(1)</a>
 807 which will handle refs correctly.</p>
 808 </div>
 809 </div>
 810 </div>
 811 <div class="sect1">
 812 <h2 id="_configuration_file">CONFIGURATION FILE</h2>
 813 <div class="sectionbody">
 814 <div class="paragraph">
 815 <p>By default, the repository <code>config</code> file is shared across all worktrees.
 816 If the config variables <code>core.bare</code> or <code>core.worktree</code> are present in the
 817 common config file and <code>extensions.worktreeConfig</code> is disabled, then they
 818 will be applied to the main worktree only.</p>
 819 </div>
 820 <div class="paragraph">
 821 <p>In order to have worktree-specific configuration, you can turn on the
 822 <code>worktreeConfig</code> extension, e.g.:</p>
 823 </div>
 824 <div class="listingblock">
 825 <div class="content">
 826 <pre>$ git config extensions.worktreeConfig true</pre>
 827 </div>
 828 </div>
 829 <div class="paragraph">
 830 <p>In this mode, specific configuration stays in the path pointed by <code>git
 831 rev-parse --git-path config.worktree</code>. You can add or update
 832 configuration in this file with <code>git config --worktree</code>. Older Git
 833 versions will refuse to access repositories with this extension.</p>
 834 </div>
 835 <div class="paragraph">
 836 <p>Note that in this file, the exception for <code>core.bare</code> and <code>core.worktree</code>
 837 is gone. If they exist in <code>$GIT_DIR/config</code>, you must move
 838 them to the <code>config.worktree</code> of the main worktree. You may also take this
 839 opportunity to review and move other configuration that you do not want to
 840 share to all worktrees:</p>
 841 </div>
 842 <div class="ulist">
 843 <ul>
 844 <li>
 845 <p><code>core.worktree</code> should never be shared.</p>
 846 </li>
 847 <li>
 848 <p><code>core.bare</code> should not be shared if the value is <code>core.bare=true</code>.</p>
 849 </li>
 850 <li>
 851 <p><code>core.sparseCheckout</code> should not be shared, unless you are sure you
 852 always use sparse checkout for all worktrees.</p>
 853 </li>
 854 </ul>
 855 </div>
 856 <div class="paragraph">
 857 <p>See the documentation of <code>extensions.worktreeConfig</code> in
 858 <a href="git-config.html">git-config(1)</a> for more details.</p>
 859 </div>
 860 </div>
 861 </div>
 862 <div class="sect1">
 863 <h2 id="_details">DETAILS</h2>
 864 <div class="sectionbody">
 865 <div class="paragraph">
 866 <p>Each linked worktree has a private sub-directory in the repository&#8217;s
 867 <code>$GIT_DIR/worktrees</code> directory.  The private sub-directory&#8217;s name is usually
 868 the base name of the linked worktree&#8217;s path, possibly appended with a
 869 number to make it unique.  For example, when <code>$GIT_DIR=/path/main/.git</code> the
 870 command <code>git worktree add /path/other/test-next next</code> creates the linked
 871 worktree in <code>/path/other/test-next</code> and also creates a
 872 <code>$GIT_DIR/worktrees/test-next</code> directory (or <code>$GIT_DIR/worktrees/test-next1</code>
 873 if <code>test-next</code> is already taken).</p>
 874 </div>
 875 <div class="paragraph">
 876 <p>Within a linked worktree, <code>$GIT_DIR</code> is set to point to this private
 877 directory (e.g. <code>/path/main/.git/worktrees/test-next</code> in the example) and
 878 <code>$GIT_COMMON_DIR</code> is set to point back to the main worktree&#8217;s <code>$GIT_DIR</code>
 879 (e.g. <code>/path/main/.git</code>). These settings are made in a <code>.git</code> file located at
 880 the top directory of the linked worktree.</p>
 881 </div>
 882 <div class="paragraph">
 883 <p>Path resolution via <code>git rev-parse --git-path</code> uses either
 884 <code>$GIT_DIR</code> or <code>$GIT_COMMON_DIR</code> depending on the path. For example, in the
 885 linked worktree <code>git rev-parse --git-path HEAD</code> returns
 886 <code>/path/main/.git/worktrees/test-next/HEAD</code> (not
 887 <code>/path/other/test-next/.git/HEAD</code> or <code>/path/main/.git/HEAD</code>) while <code>git
 888 rev-parse --git-path refs/heads/master</code> uses
 889 <code>$GIT_COMMON_DIR</code> and returns <code>/path/main/.git/refs/heads/master</code>,
 890 since refs are shared across all worktrees, except <code>refs/bisect</code>,
 891 <code>refs/worktree</code> and <code>refs/rewritten</code>.</p>
 892 </div>
 893 <div class="paragraph">
 894 <p>See <a href="gitrepository-layout.html">gitrepository-layout(5)</a> for more information. The rule of
 895 thumb is do not make any assumption about whether a path belongs to
 896 <code>$GIT_DIR</code> or <code>$GIT_COMMON_DIR</code> when you need to directly access something
 897 inside <code>$GIT_DIR</code>. Use <code>git rev-parse --git-path</code> to get the final path.</p>
 898 </div>
 899 <div class="paragraph">
 900 <p>If you manually move a linked worktree, you need to update the <code>gitdir</code> file
 901 in the entry&#8217;s directory. For example, if a linked worktree is moved
 902 to <code>/newpath/test-next</code> and its <code>.git</code> file points to
 903 <code>/path/main/.git/worktrees/test-next</code>, then update
 904 <code>/path/main/.git/worktrees/test-next/gitdir</code> to reference <code>/newpath/test-next</code>
 905 instead. Better yet, run <code>git worktree repair</code> to reestablish the connection
 906 automatically.</p>
 907 </div>
 908 <div class="paragraph">
 909 <p>To prevent a <code>$GIT_DIR/worktrees</code> entry from being pruned (which
 910 can be useful in some situations, such as when the
 911 entry&#8217;s worktree is stored on a portable device), use the
 912 <code>git worktree lock</code> command, which adds a file named
 913 <code>locked</code> to the entry&#8217;s directory. The file contains the reason in
 914 plain text. For example, if a linked worktree&#8217;s <code>.git</code> file points
 915 to <code>/path/main/.git/worktrees/test-next</code> then a file named
 916 <code>/path/main/.git/worktrees/test-next/locked</code> will prevent the
 917 <code>test-next</code> entry from being pruned.  See
 918 <a href="gitrepository-layout.html">gitrepository-layout(5)</a> for details.</p>
 919 </div>
 920 <div class="paragraph">
 921 <p>When <code>extensions.worktreeConfig</code> is enabled, the config file
 922 <code>.git/worktrees/&lt;id&gt;/config.worktree</code> is read after <code>.git/config</code> is.</p>
 923 </div>
 924 </div>
 925 </div>
 926 <div class="sect1">
 927 <h2 id="_list_output_format">LIST OUTPUT FORMAT</h2>
 928 <div class="sectionbody">
 929 <div class="paragraph">
 930 <p>The <code>worktree list</code> command has two output formats. The default format shows the
 931 details on a single line with columns.  For example:</p>
 932 </div>
 933 <div class="listingblock">
 934 <div class="content">
 935 <pre>$ git worktree list
 936 /path/to/bare-source            (bare)
 937 /path/to/linked-worktree        abcd1234 [master]
 938 /path/to/other-linked-worktree  1234abc  (detached HEAD)</pre>
 939 </div>
 940 </div>
 941 <div class="paragraph">
 942 <p>The command also shows annotations for each worktree, according to its state.
 943 These annotations are:</p>
 944 </div>
 945 <div class="ulist">
 946 <ul>
 947 <li>
 948 <p><code>locked</code>, if the worktree is locked.</p>
 949 </li>
 950 <li>
 951 <p><code>prunable</code>, if the worktree can be pruned via <code>git worktree prune</code>.</p>
 952 </li>
 953 </ul>
 954 </div>
 955 <div class="listingblock">
 956 <div class="content">
 957 <pre>$ git worktree list
 958 /path/to/linked-worktree    abcd1234 [master]
 959 /path/to/locked-worktree    acbd5678 (brancha) locked
 960 /path/to/prunable-worktree  5678abc  (detached HEAD) prunable</pre>
 961 </div>
 962 </div>
 963 <div class="paragraph">
 964 <p>For these annotations, a reason might also be available and this can be
 965 seen using the verbose mode. The annotation is then moved to the next line
 966 indented followed by the additional information.</p>
 967 </div>
 968 <div class="listingblock">
 969 <div class="content">
 970 <pre>$ git worktree list --verbose
 971 /path/to/linked-worktree              abcd1234 [master]
 972 /path/to/locked-worktree-no-reason    abcd5678 (detached HEAD) locked
 973 /path/to/locked-worktree-with-reason  1234abcd (brancha)
 974         locked: worktree path is mounted on a portable device
 975 /path/to/prunable-worktree            5678abc1 (detached HEAD)
 976         prunable: gitdir file points to non-existent location</pre>
 977 </div>
 978 </div>
 979 <div class="paragraph">
 980 <p>Note that the annotation is moved to the next line if the additional
 981 information is available, otherwise it stays on the same line as the
 982 worktree itself.</p>
 983 </div>
 984 <div class="sect2">
 985 <h3 id="_porcelain_format">Porcelain Format</h3>
 986 <div class="paragraph">
 987 <p>The porcelain format has a line per attribute.  If <code>-z</code> is given then the lines
 988 are terminated with NUL rather than a newline.  Attributes are listed with a
 989 label and value separated by a single space.  Boolean attributes (like <code>bare</code>
 990 and <code>detached</code>) are listed as a label only, and are present only
 991 if the value is true.  Some attributes (like <code>locked</code>) can be listed as a label
 992 only or with a value depending upon whether a reason is available.  The first
 993 attribute of a worktree is always <code>worktree</code>, an empty line indicates the
 994 end of the record.  For example:</p>
 995 </div>
 996 <div class="listingblock">
 997 <div class="content">
 998 <pre>$ git worktree list --porcelain
 999 worktree /path/to/bare-source
1000 bare
1001
1002 worktree /path/to/linked-worktree
1003 HEAD abcd1234abcd1234abcd1234abcd1234abcd1234
1004 branch refs/heads/master
1005
1006 worktree /path/to/other-linked-worktree
1007 HEAD 1234abc1234abc1234abc1234abc1234abc1234a
1008 detached
1009
1010 worktree /path/to/linked-worktree-locked-no-reason
1011 HEAD 5678abc5678abc5678abc5678abc5678abc5678c
1012 branch refs/heads/locked-no-reason
1013 locked
1014
1015 worktree /path/to/linked-worktree-locked-with-reason
1016 HEAD 3456def3456def3456def3456def3456def3456b
1017 branch refs/heads/locked-with-reason
1018 locked reason why is locked
1019
1020 worktree /path/to/linked-worktree-prunable
1021 HEAD 1233def1234def1234def1234def1234def1234b
1022 detached
1023 prunable gitdir file points to non-existent location</pre>
1024 </div>
1025 </div>
1026 <div class="paragraph">
1027 <p>Unless <code>-z</code> is used any "unusual" characters in the lock reason such as newlines
1028 are escaped and the entire reason is quoted as explained for the
1029 configuration variable <code>core.quotePath</code> (see <a href="git-config.html">git-config(1)</a>).
1030 For Example:</p>
1031 </div>
1032 <div class="listingblock">
1033 <div class="content">
1034 <pre>$ git worktree list --porcelain
1035 ...
1036 locked "reason\nwhy is locked"
1037 ...</pre>
1038 </div>
1039 </div>
1040 </div>
1041 </div>
1042 </div>
1043 <div class="sect1">
1044 <h2 id="_examples">EXAMPLES</h2>
1045 <div class="sectionbody">
1046 <div class="paragraph">
1047 <p>You are in the middle of a refactoring session and your boss comes in and
1048 demands that you fix something immediately. You might typically use
1049 <a href="git-stash.html">git-stash(1)</a> to store your changes away temporarily, however, your
1050 working tree is in such a state of disarray (with new, moved, and removed
1051 files, and other bits and pieces strewn around) that you don&#8217;t want to risk
1052 disturbing any of it. Instead, you create a temporary linked worktree to
1053 make the emergency fix, remove it when done, and then resume your earlier
1054 refactoring session.</p>
1055 </div>
1056 <div class="listingblock">
1057 <div class="content">
1058 <pre>$ git worktree add -b emergency-fix ../temp master
1059 $ pushd ../temp
1060 # ... hack hack hack ...
1061 $ git commit -a -m 'emergency fix for boss'
1062 $ popd
1063 $ git worktree remove ../temp</pre>
1064 </div>
1065 </div>
1066 </div>
1067 </div>
1068 <div class="sect1">
1069 <h2 id="_bugs">BUGS</h2>
1070 <div class="sectionbody">
1071 <div class="paragraph">
1072 <p>Multiple checkout in general is still experimental, and the support
1073 for submodules is incomplete. It is NOT recommended to make multiple
1074 checkouts of a superproject.</p>
1075 </div>
1076 </div>
1077 </div>
1078 <div class="sect1">
1079 <h2 id="_git">GIT</h2>
1080 <div class="sectionbody">
1081 <div class="paragraph">
1082 <p>Part of the <a href="git.html">git(1)</a> suite</p>
1083 </div>
1084 </div>
1085 </div>
1086 </div>
1087 <div id="footer">
1088 <div id="footer-text">
1089 Last updated 2024-01-02 14:28:43 -0800
1090 </div>
1091 </div>
1092 </body>
1093 </html>