worktree: teach "add" to check out existing branches
[git.git] / Documentation / git-worktree.txt
1 git-worktree(1)
2 ===============
5 ----
6 git-worktree - Manage multiple working trees
10 --------
11 [verse]
12 'git worktree add' [-f] [--detach] [--checkout] [--lock] [-b <new-branch>] <path> [<commit-ish>]
13 'git worktree list' [--porcelain]
14 'git worktree lock' [--reason <string>] <worktree>
15 'git worktree prune' [-n] [-v] [--expire <expire>]
16 'git worktree unlock' <worktree>
19 -----------
21 Manage multiple working trees attached to the same repository.
23 A git repository can support multiple working trees, allowing you to check
24 out more than one branch at a time.  With `git worktree add` a new working
25 tree is associated with the repository.  This new working tree is called a
26 "linked working tree" as opposed to the "main working tree" prepared by "git
27 init" or "git clone".  A repository has one main working tree (if it's not a
28 bare repository) and zero or more linked working trees.
30 When you are done with a linked working tree you can simply delete it.
31 The working tree's administrative files in the repository (see
32 "DETAILS" below) will eventually be removed automatically (see
33 `gc.worktreePruneExpire` in linkgit:git-config[1]), or you can run
34 `git worktree prune` in the main or any linked working tree to
35 clean up any stale administrative files.
37 If you move a linked working tree, you need to manually update the
38 administrative files so that they do not get pruned automatically. See
39 section "DETAILS" for more information.
41 If a linked working tree is stored on a portable device or network share
42 which is not always mounted, you can prevent its administrative files from
43 being pruned by issuing the `git worktree lock` command, optionally
44 specifying `--reason` to explain why the working tree is locked.
47 --------
48 add <path> [<commit-ish>]::
50 Create `<path>` and checkout `<commit-ish>` into it. The new working directory
51 is linked to the current repository, sharing everything except working
52 directory specific files such as HEAD, index, etc. `-` may also be
53 specified as `<commit-ish>`; it is synonymous with `@{-1}`.
55 If <commit-ish> is a branch name (call it `<branch>` and is not found,
56 and neither `-b` nor `-B` nor `--detach` are used, but there does
57 exist a tracking branch in exactly one remote (call it `<remote>`)
58 with a matching name, treat as equivalent to
59 ------------
60 $ git worktree add --track -b <branch> <path> <remote>/<branch>
61 ------------
63 If `<commit-ish>` is omitted and neither `-b` nor `-B` nor `--detach` used,
64 then, as a convenience, the new worktree is associated with a branch
65 (call it `<branch>`) named after `$(basename <path>)`.  If `<branch>`
66 doesn't exist, a new branch based on HEAD is automatically created as
67 if `-b <branch>` was given.  If `<branch>` does exist, it will be
68 checked out in the new worktree, if it's not checked out anywhere
69 else, otherwise the command will refuse to create the worktree (unless
70 `--force` is used).
72 list::
74 List details of each worktree.  The main worktree is listed first, followed by
75 each of the linked worktrees.  The output details include if the worktree is
76 bare, the revision currently checked out, and the branch currently checked out
77 (or 'detached HEAD' if none).
79 lock::
81 If a working tree is on a portable device or network share which
82 is not always mounted, lock it to prevent its administrative
83 files from being pruned automatically. This also prevents it from
84 being moved or deleted. Optionally, specify a reason for the lock
85 with `--reason`.
87 prune::
89 Prune working tree information in $GIT_DIR/worktrees.
91 unlock::
93 Unlock a working tree, allowing it to be pruned, moved or deleted.
96 -------
98 -f::
99 --force::
100         By default, `add` refuses to create a new working tree when `<commit-ish>` is a branch name and
101         is already checked out by another working tree. This option overrides
102         that safeguard.
104 -b <new-branch>::
105 -B <new-branch>::
106         With `add`, create a new branch named `<new-branch>` starting at
107         `<commit-ish>`, and check out `<new-branch>` into the new working tree.
108         If `<commit-ish>` is omitted, it defaults to HEAD.
109         By default, `-b` refuses to create a new branch if it already
110         exists. `-B` overrides this safeguard, resetting `<new-branch>` to
111         `<commit-ish>`.
113 --detach::
114         With `add`, detach HEAD in the new working tree. See "DETACHED HEAD"
115         in linkgit:git-checkout[1].
117 --[no-]checkout::
118         By default, `add` checks out `<commit-ish>`, however, `--no-checkout` can
119         be used to suppress checkout in order to make customizations,
120         such as configuring sparse-checkout. See "Sparse checkout"
121         in linkgit:git-read-tree[1].
123 --[no-]guess-remote::
124         With `worktree add <path>`, without `<commit-ish>`, instead
125         of creating a new branch from HEAD, if there exists a tracking
126         branch in exactly one remote matching the basename of `<path>`,
127         base the new branch on the remote-tracking branch, and mark
128         the remote-tracking branch as "upstream" from the new branch.
130 This can also be set up as the default behaviour by using the
131 `worktree.guessRemote` config option.
133 --[no-]track::
134         When creating a new branch, if `<commit-ish>` is a branch,
135         mark it as "upstream" from the new branch.  This is the
136         default if `<commit-ish>` is a remote-tracking branch.  See
137         "--track" in linkgit:git-branch[1] for details.
139 --lock::
140         Keep the working tree locked after creation. This is the
141         equivalent of `git worktree lock` after `git worktree add`,
142         but without race condition.
144 -n::
145 --dry-run::
146         With `prune`, do not remove anything; just report what it would
147         remove.
149 --porcelain::
150         With `list`, output in an easy-to-parse format for scripts.
151         This format will remain stable across Git versions and regardless of user
152         configuration.  See below for details.
154 -v::
155 --verbose::
156         With `prune`, report all removals.
158 --expire <time>::
159         With `prune`, only expire unused working trees older than <time>.
161 --reason <string>::
162         With `lock`, an explanation why the working tree is locked.
164 <worktree>::
165         Working trees can be identified by path, either relative or
166         absolute.
168 If the last path components in the working tree's path is unique among
169 working trees, it can be used to identify worktrees. For example if
170 you only have two working trees, at "/abc/def/ghi" and "/abc/def/ggg",
171 then "ghi" or "def/ghi" is enough to point to the former working tree.
174 -------
175 Each linked working tree has a private sub-directory in the repository's
176 $GIT_DIR/worktrees directory.  The private sub-directory's name is usually
177 the base name of the linked working tree's path, possibly appended with a
178 number to make it unique.  For example, when `$GIT_DIR=/path/main/.git` the
179 command `git worktree add /path/other/test-next next` creates the linked
180 working tree in `/path/other/test-next` and also creates a
181 `$GIT_DIR/worktrees/test-next` directory (or `$GIT_DIR/worktrees/test-next1`
182 if `test-next` is already taken).
184 Within a linked working tree, $GIT_DIR is set to point to this private
185 directory (e.g. `/path/main/.git/worktrees/test-next` in the example) and
186 $GIT_COMMON_DIR is set to point back to the main working tree's $GIT_DIR
187 (e.g. `/path/main/.git`). These settings are made in a `.git` file located at
188 the top directory of the linked working tree.
190 Path resolution via `git rev-parse --git-path` uses either
191 $GIT_DIR or $GIT_COMMON_DIR depending on the path. For example, in the
192 linked working tree `git rev-parse --git-path HEAD` returns
193 `/path/main/.git/worktrees/test-next/HEAD` (not
194 `/path/other/test-next/.git/HEAD` or `/path/main/.git/HEAD`) while `git
195 rev-parse --git-path refs/heads/master` uses
196 $GIT_COMMON_DIR and returns `/path/main/.git/refs/heads/master`,
197 since refs are shared across all working trees.
199 See linkgit:gitrepository-layout[5] for more information. The rule of
200 thumb is do not make any assumption about whether a path belongs to
201 $GIT_DIR or $GIT_COMMON_DIR when you need to directly access something
202 inside $GIT_DIR. Use `git rev-parse --git-path` to get the final path.
204 If you move a linked working tree, you need to update the 'gitdir' file
205 in the entry's directory. For example, if a linked working tree is moved
206 to `/newpath/test-next` and its `.git` file points to
207 `/path/main/.git/worktrees/test-next`, then update
208 `/path/main/.git/worktrees/test-next/gitdir` to reference `/newpath/test-next`
209 instead.
211 To prevent a $GIT_DIR/worktrees entry from being pruned (which
212 can be useful in some situations, such as when the
213 entry's working tree is stored on a portable device), use the
214 `git worktree lock` command, which adds a file named
215 'locked' to the entry's directory. The file contains the reason in
216 plain text. For example, if a linked working tree's `.git` file points
217 to `/path/main/.git/worktrees/test-next` then a file named
218 `/path/main/.git/worktrees/test-next/locked` will prevent the
219 `test-next` entry from being pruned.  See
220 linkgit:gitrepository-layout[5] for details.
223 ------------------
224 The worktree list command has two output formats.  The default format shows the
225 details on a single line with columns.  For example:
227 ------------
228 S git worktree list
229 /path/to/bare-source            (bare)
230 /path/to/linked-worktree        abcd1234 [master]
231 /path/to/other-linked-worktree  1234abc  (detached HEAD)
232 ------------
234 Porcelain Format
235 ~~~~~~~~~~~~~~~~
236 The porcelain format has a line per attribute.  Attributes are listed with a
237 label and value separated by a single space.  Boolean attributes (like 'bare'
238 and 'detached') are listed as a label only, and are only present if and only
239 if the value is true.  An empty line indicates the end of a worktree.  For
240 example:
242 ------------
243 S git worktree list --porcelain
244 worktree /path/to/bare-source
245 bare
247 worktree /path/to/linked-worktree
248 HEAD abcd1234abcd1234abcd1234abcd1234abcd1234
249 branch refs/heads/master
251 worktree /path/to/other-linked-worktree
252 HEAD 1234abc1234abc1234abc1234abc1234abc1234a
253 detached
255 ------------
258 --------
259 You are in the middle of a refactoring session and your boss comes in and
260 demands that you fix something immediately. You might typically use
261 linkgit:git-stash[1] to store your changes away temporarily, however, your
262 working tree is in such a state of disarray (with new, moved, and removed
263 files, and other bits and pieces strewn around) that you don't want to risk
264 disturbing any of it. Instead, you create a temporary linked working tree to
265 make the emergency fix, remove it when done, and then resume your earlier
266 refactoring session.
268 ------------
269 $ git worktree add -b emergency-fix ../temp master
270 $ pushd ../temp
271 # ... hack hack hack ...
272 $ git commit -a -m 'emergency fix for boss'
273 $ popd
274 $ rm -rf ../temp
275 $ git worktree prune
276 ------------
278 BUGS
279 ----
280 Multiple checkout in general is still experimental, and the support
281 for submodules is incomplete. It is NOT recommended to make multiple
282 checkouts of a superproject.
284 git-worktree could provide more automation for tasks currently
285 performed manually, such as:
287 - `remove` to remove a linked working tree and its administrative files (and
288   warn if the working tree is dirty)
289 - `mv` to move or rename a working tree and update its administrative files
293 Part of the linkgit:git[1] suite