worktree: add --quiet option
[git/git.git] / Documentation / git-worktree.txt
CommitLineData
df0b6cfb
NTND
1git-worktree(1)
2===============
3
4NAME
5----
bc483285 6git-worktree - Manage multiple working trees
df0b6cfb
NTND
7
8
9SYNOPSIS
10--------
11[verse]
c4738aed 12'git worktree add' [-f] [--detach] [--checkout] [--lock] [-b <new-branch>] <path> [<commit-ish>]
bb9c03b8 13'git worktree list' [--porcelain]
58142c09 14'git worktree lock' [--reason <string>] <worktree>
9f792bb4 15'git worktree move' <worktree> <new-path>
7b722d90 16'git worktree prune' [-n] [-v] [--expire <expire>]
d228eea5 17'git worktree remove' [-f] <worktree>
6d308627 18'git worktree unlock' <worktree>
df0b6cfb
NTND
19
20DESCRIPTION
21-----------
22
bc483285 23Manage multiple working trees attached to the same repository.
df0b6cfb 24
93a36493 25A git repository can support multiple working trees, allowing you to check
4d5a3c58 26out more than one branch at a time. With `git worktree add` a new working
93a36493
ES
27tree is associated with the repository. This new working tree is called a
28"linked working tree" as opposed to the "main working tree" prepared by "git
29init" or "git clone". A repository has one main working tree (if it's not a
3f0b42bd
ES
30bare repository) and zero or more linked working trees. When you are done
31with a linked working tree, remove it with `git worktree remove`.
93a36493 32
3f0b42bd
ES
33If a working tree is deleted without using `git worktree remove`, then
34its associated administrative files, which reside in the repository
35(see "DETAILS" below), will eventually be removed automatically (see
5f5f553f 36`gc.worktreePruneExpire` in linkgit:git-config[1]), or you can run
93a36493 37`git worktree prune` in the main or any linked working tree to
af189b4c 38clean up any stale administrative files.
93a36493 39
a8ba5dd7
ES
40If a linked working tree is stored on a portable device or network share
41which is not always mounted, you can prevent its administrative files from
58142c09
NTND
42being pruned by issuing the `git worktree lock` command, optionally
43specifying `--reason` to explain why the working tree is locked.
93a36493 44
df0b6cfb
NTND
45COMMANDS
46--------
c4738aed 47add <path> [<commit-ish>]::
fc56361f 48
c4738aed 49Create `<path>` and checkout `<commit-ish>` into it. The new working directory
fc56361f 50is linked to the current repository, sharing everything except working
1a450e2f 51directory specific files such as HEAD, index, etc. `-` may also be
c4738aed 52specified as `<commit-ish>`; it is synonymous with `@{-1}`.
1eb07d82 53+
661a5a38 54If <commit-ish> is a branch name (call it `<branch>`) and is not found,
4e853331
TG
55and neither `-b` nor `-B` nor `--detach` are used, but there does
56exist a tracking branch in exactly one remote (call it `<remote>`)
661a5a38 57with a matching name, treat as equivalent to:
d023df1e 58+
4e853331
TG
59------------
60$ git worktree add --track -b <branch> <path> <remote>/<branch>
61------------
62+
8d7b558b
ÆAB
63If the branch exists in multiple remotes and one of them is named by
64the `checkout.defaultRemote` configuration variable, we'll use that
65one for the purposes of disambiguation, even if the `<branch>` isn't
66unique across all remotes. Set it to
67e.g. `checkout.defaultRemote=origin` to always checkout remote
68branches from there if `<branch>` is ambiguous but exists on the
69'origin' remote. See also `checkout.defaultRemote` in
70linkgit:git-config[1].
71+
c4738aed 72If `<commit-ish>` is omitted and neither `-b` nor `-B` nor `--detach` used,
f60a7b76
TG
73then, as a convenience, the new worktree is associated with a branch
74(call it `<branch>`) named after `$(basename <path>)`. If `<branch>`
75doesn't exist, a new branch based on HEAD is automatically created as
76if `-b <branch>` was given. If `<branch>` does exist, it will be
77checked out in the new worktree, if it's not checked out anywhere
78else, otherwise the command will refuse to create the worktree (unless
79`--force` is used).
fc56361f 80
bb9c03b8
MR
81list::
82
83List details of each worktree. The main worktree is listed first, followed by
84each of the linked worktrees. The output details include if the worktree is
85bare, the revision currently checked out, and the branch currently checked out
86(or 'detached HEAD' if none).
87
58142c09
NTND
88lock::
89
90If a working tree is on a portable device or network share which
91is not always mounted, lock it to prevent its administrative
92files from being pruned automatically. This also prevents it from
93being moved or deleted. Optionally, specify a reason for the lock
94with `--reason`.
95
9f792bb4
NTND
96move::
97
98Move a working tree to a new location. Note that the main working tree
78d986b2 99or linked working trees containing submodules cannot be moved.
9f792bb4 100
7b722d90
NTND
101prune::
102
103Prune working tree information in $GIT_DIR/worktrees.
104
cc73385c
NTND
105remove::
106
107Remove a working tree. Only clean working trees (no untracked files
108and no modification in tracked files) can be removed. Unclean working
109trees or ones with submodules can be removed with `--force`. The main
110working tree cannot be removed.
111
6d308627
NTND
112unlock::
113
114Unlock a working tree, allowing it to be pruned, moved or deleted.
115
df0b6cfb
NTND
116OPTIONS
117-------
118
f4325444
ES
119-f::
120--force::
cc73385c
NTND
121 By default, `add` refuses to create a new working tree when
122 `<commit-ish>` is a branch name and is already checked out by
123 another working tree and `remove` refuses to remove an unclean
3f0b42bd 124 working tree. This option overrides these safeguards.
f4325444 125
cbdf60fa
ES
126-b <new-branch>::
127-B <new-branch>::
128 With `add`, create a new branch named `<new-branch>` starting at
c4738aed
TG
129 `<commit-ish>`, and check out `<new-branch>` into the new working tree.
130 If `<commit-ish>` is omitted, it defaults to HEAD.
cbdf60fa
ES
131 By default, `-b` refuses to create a new branch if it already
132 exists. `-B` overrides this safeguard, resetting `<new-branch>` to
c4738aed 133 `<commit-ish>`.
cbdf60fa 134
39ecb274 135--detach::
bc483285
MH
136 With `add`, detach HEAD in the new working tree. See "DETACHED HEAD"
137 in linkgit:git-checkout[1].
39ecb274 138
ef2a0ac9 139--[no-]checkout::
c4738aed 140 By default, `add` checks out `<commit-ish>`, however, `--no-checkout` can
ef2a0ac9
RZ
141 be used to suppress checkout in order to make customizations,
142 such as configuring sparse-checkout. See "Sparse checkout"
143 in linkgit:git-read-tree[1].
144
71d6682d
TG
145--[no-]guess-remote::
146 With `worktree add <path>`, without `<commit-ish>`, instead
147 of creating a new branch from HEAD, if there exists a tracking
50fdf7b1 148 branch in exactly one remote matching the basename of `<path>`,
71d6682d
TG
149 base the new branch on the remote-tracking branch, and mark
150 the remote-tracking branch as "upstream" from the new branch.
e92445a7
TG
151+
152This can also be set up as the default behaviour by using the
153`worktree.guessRemote` config option.
71d6682d 154
e284e892
TG
155--[no-]track::
156 When creating a new branch, if `<commit-ish>` is a branch,
157 mark it as "upstream" from the new branch. This is the
158 default if `<commit-ish>` is a remote-tracking branch. See
159 "--track" in linkgit:git-branch[1] for details.
160
507e6e9e
NTND
161--lock::
162 Keep the working tree locked after creation. This is the
163 equivalent of `git worktree lock` after `git worktree add`,
164 but without race condition.
165
df0b6cfb
NTND
166-n::
167--dry-run::
4f09825e 168 With `prune`, do not remove anything; just report what it would
df0b6cfb
NTND
169 remove.
170
bb9c03b8
MR
171--porcelain::
172 With `list`, output in an easy-to-parse format for scripts.
173 This format will remain stable across Git versions and regardless of user
174 configuration. See below for details.
175
371979c2
EP
176-q::
177--quiet::
178 With 'add', suppress feedback messages.
179
df0b6cfb
NTND
180-v::
181--verbose::
4f09825e 182 With `prune`, report all removals.
df0b6cfb
NTND
183
184--expire <time>::
bc483285 185 With `prune`, only expire unused working trees older than <time>.
df0b6cfb 186
58142c09
NTND
187--reason <string>::
188 With `lock`, an explanation why the working tree is locked.
189
190<worktree>::
191 Working trees can be identified by path, either relative or
192 absolute.
080739ba
NTND
193+
194If the last path components in the working tree's path is unique among
195working trees, it can be used to identify worktrees. For example if
2b090822 196you only have two working trees, at "/abc/def/ghi" and "/abc/def/ggg",
080739ba 197then "ghi" or "def/ghi" is enough to point to the former working tree.
58142c09 198
af189b4c
ES
199DETAILS
200-------
201Each linked working tree has a private sub-directory in the repository's
202$GIT_DIR/worktrees directory. The private sub-directory's name is usually
203the base name of the linked working tree's path, possibly appended with a
204number to make it unique. For example, when `$GIT_DIR=/path/main/.git` the
4d5a3c58 205command `git worktree add /path/other/test-next next` creates the linked
af189b4c
ES
206working tree in `/path/other/test-next` and also creates a
207`$GIT_DIR/worktrees/test-next` directory (or `$GIT_DIR/worktrees/test-next1`
208if `test-next` is already taken).
209
210Within a linked working tree, $GIT_DIR is set to point to this private
211directory (e.g. `/path/main/.git/worktrees/test-next` in the example) and
212$GIT_COMMON_DIR is set to point back to the main working tree's $GIT_DIR
213(e.g. `/path/main/.git`). These settings are made in a `.git` file located at
214the top directory of the linked working tree.
215
216Path resolution via `git rev-parse --git-path` uses either
217$GIT_DIR or $GIT_COMMON_DIR depending on the path. For example, in the
218linked working tree `git rev-parse --git-path HEAD` returns
219`/path/main/.git/worktrees/test-next/HEAD` (not
220`/path/other/test-next/.git/HEAD` or `/path/main/.git/HEAD`) while `git
221rev-parse --git-path refs/heads/master` uses
222$GIT_COMMON_DIR and returns `/path/main/.git/refs/heads/master`,
223since refs are shared across all working trees.
224
225See linkgit:gitrepository-layout[5] for more information. The rule of
226thumb is do not make any assumption about whether a path belongs to
227$GIT_DIR or $GIT_COMMON_DIR when you need to directly access something
228inside $GIT_DIR. Use `git rev-parse --git-path` to get the final path.
229
9f792bb4 230If you manually move a linked working tree, you need to update the 'gitdir' file
618244e1
NTND
231in the entry's directory. For example, if a linked working tree is moved
232to `/newpath/test-next` and its `.git` file points to
233`/path/main/.git/worktrees/test-next`, then update
234`/path/main/.git/worktrees/test-next/gitdir` to reference `/newpath/test-next`
235instead.
236
65f9b75d 237To prevent a $GIT_DIR/worktrees entry from being pruned (which
a8ba5dd7 238can be useful in some situations, such as when the
58142c09
NTND
239entry's working tree is stored on a portable device), use the
240`git worktree lock` command, which adds a file named
a8ba5dd7
ES
241'locked' to the entry's directory. The file contains the reason in
242plain text. For example, if a linked working tree's `.git` file points
243to `/path/main/.git/worktrees/test-next` then a file named
244`/path/main/.git/worktrees/test-next/locked` will prevent the
245`test-next` entry from being pruned. See
246linkgit:gitrepository-layout[5] for details.
247
bb9c03b8
MR
248LIST OUTPUT FORMAT
249------------------
250The worktree list command has two output formats. The default format shows the
251details on a single line with columns. For example:
252
253------------
22d11a6e 254$ git worktree list
bb9c03b8
MR
255/path/to/bare-source (bare)
256/path/to/linked-worktree abcd1234 [master]
257/path/to/other-linked-worktree 1234abc (detached HEAD)
258------------
259
260Porcelain Format
261~~~~~~~~~~~~~~~~
262The porcelain format has a line per attribute. Attributes are listed with a
263label and value separated by a single space. Boolean attributes (like 'bare'
264and 'detached') are listed as a label only, and are only present if and only
265if the value is true. An empty line indicates the end of a worktree. For
266example:
267
268------------
22d11a6e 269$ git worktree list --porcelain
bb9c03b8
MR
270worktree /path/to/bare-source
271bare
272
273worktree /path/to/linked-worktree
274HEAD abcd1234abcd1234abcd1234abcd1234abcd1234
275branch refs/heads/master
276
277worktree /path/to/other-linked-worktree
278HEAD 1234abc1234abc1234abc1234abc1234abc1234a
279detached
280
281------------
282
96454597
ES
283EXAMPLES
284--------
285You are in the middle of a refactoring session and your boss comes in and
286demands that you fix something immediately. You might typically use
287linkgit:git-stash[1] to store your changes away temporarily, however, your
bc483285
MH
288working tree is in such a state of disarray (with new, moved, and removed
289files, and other bits and pieces strewn around) that you don't want to risk
290disturbing any of it. Instead, you create a temporary linked working tree to
96454597
ES
291make the emergency fix, remove it when done, and then resume your earlier
292refactoring session.
293
294------------
cbdf60fa 295$ git worktree add -b emergency-fix ../temp master
96454597
ES
296$ pushd ../temp
297# ... hack hack hack ...
298$ git commit -a -m 'emergency fix for boss'
299$ popd
3f0b42bd 300$ git worktree remove ../temp
96454597
ES
301------------
302
6d3824cf
ES
303BUGS
304----
18b22dbe
JH
305Multiple checkout in general is still experimental, and the support
306for submodules is incomplete. It is NOT recommended to make multiple
307checkouts of a superproject.
6d3824cf 308
df0b6cfb
NTND
309GIT
310---
311Part of the linkgit:git[1] suite