]>
Commit | Line | Data |
---|---|---|
df0b6cfb NTND |
1 | git-worktree(1) |
2 | =============== | |
3 | ||
4 | NAME | |
5 | ---- | |
bc483285 | 6 | git-worktree - Manage multiple working trees |
df0b6cfb NTND |
7 | |
8 | ||
9 | SYNOPSIS | |
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> |
b214ab5a | 18 | 'git worktree repair' [<path>...] |
6d308627 | 19 | 'git worktree unlock' <worktree> |
df0b6cfb NTND |
20 | |
21 | DESCRIPTION | |
22 | ----------- | |
23 | ||
bc483285 | 24 | Manage multiple working trees attached to the same repository. |
df0b6cfb | 25 | |
93a36493 | 26 | A git repository can support multiple working trees, allowing you to check |
4d5a3c58 | 27 | out more than one branch at a time. With `git worktree add` a new working |
93a36493 | 28 | tree is associated with the repository. This new working tree is called a |
dc9c144b ES |
29 | "linked working tree" as opposed to the "main working tree" prepared by |
30 | linkgit:git-init[1] or linkgit:git-clone[1]. | |
31 | A repository has one main working tree (if it's not a | |
3f0b42bd ES |
32 | bare repository) and zero or more linked working trees. When you are done |
33 | with a linked working tree, remove it with `git worktree remove`. | |
93a36493 | 34 | |
dccadad7 ES |
35 | In its simplest form, `git worktree add <path>` automatically creates a |
36 | new branch whose name is the final component of `<path>`, which is | |
37 | convenient if you plan to work on a new topic. For instance, `git | |
38 | worktree add ../hotfix` creates new branch `hotfix` and checks it out at | |
39 | path `../hotfix`. To instead work on an existing branch in a new working | |
40 | tree, use `git worktree add <path> <branch>`. On the other hand, if you | |
41 | just plan to make some experimental changes or do testing without | |
42 | disturbing existing development, it is often convenient to create a | |
43 | 'throwaway' working tree not associated with any branch. For instance, | |
44 | `git worktree add -d <path>` creates a new working tree with a detached | |
45 | `HEAD` at the same commit as the current branch. | |
46 | ||
3f0b42bd ES |
47 | If a working tree is deleted without using `git worktree remove`, then |
48 | its associated administrative files, which reside in the repository | |
49 | (see "DETAILS" below), will eventually be removed automatically (see | |
5f5f553f | 50 | `gc.worktreePruneExpire` in linkgit:git-config[1]), or you can run |
93a36493 | 51 | `git worktree prune` in the main or any linked working tree to |
af189b4c | 52 | clean up any stale administrative files. |
93a36493 | 53 | |
a8ba5dd7 ES |
54 | If a linked working tree is stored on a portable device or network share |
55 | which is not always mounted, you can prevent its administrative files from | |
58142c09 NTND |
56 | being pruned by issuing the `git worktree lock` command, optionally |
57 | specifying `--reason` to explain why the working tree is locked. | |
93a36493 | 58 | |
df0b6cfb NTND |
59 | COMMANDS |
60 | -------- | |
c4738aed | 61 | add <path> [<commit-ish>]:: |
fc56361f | 62 | |
c4738aed | 63 | Create `<path>` and checkout `<commit-ish>` into it. The new working directory |
fc56361f | 64 | is linked to the current repository, sharing everything except working |
1933f6ce ES |
65 | directory specific files such as `HEAD`, `index`, etc. As a convenience, |
66 | `<commit-ish>` may be a bare "`-`", which is synonymous with `@{-1}`. | |
1eb07d82 | 67 | + |
e79e313c | 68 | If `<commit-ish>` is a branch name (call it `<branch>`) and is not found, |
4e853331 TG |
69 | and neither `-b` nor `-B` nor `--detach` are used, but there does |
70 | exist a tracking branch in exactly one remote (call it `<remote>`) | |
661a5a38 | 71 | with a matching name, treat as equivalent to: |
d023df1e | 72 | + |
4e853331 TG |
73 | ------------ |
74 | $ git worktree add --track -b <branch> <path> <remote>/<branch> | |
75 | ------------ | |
76 | + | |
8d7b558b ÆAB |
77 | If the branch exists in multiple remotes and one of them is named by |
78 | the `checkout.defaultRemote` configuration variable, we'll use that | |
79 | one for the purposes of disambiguation, even if the `<branch>` isn't | |
80 | unique across all remotes. Set it to | |
81 | e.g. `checkout.defaultRemote=origin` to always checkout remote | |
82 | branches from there if `<branch>` is ambiguous but exists on the | |
e79e313c | 83 | `origin` remote. See also `checkout.defaultRemote` in |
8d7b558b ÆAB |
84 | linkgit:git-config[1]. |
85 | + | |
c4738aed | 86 | If `<commit-ish>` is omitted and neither `-b` nor `-B` nor `--detach` used, |
4f375b26 | 87 | then, as a convenience, the new working tree is associated with a branch |
f60a7b76 | 88 | (call it `<branch>`) named after `$(basename <path>)`. If `<branch>` |
e79e313c | 89 | doesn't exist, a new branch based on `HEAD` is automatically created as |
f60a7b76 | 90 | if `-b <branch>` was given. If `<branch>` does exist, it will be |
4f375b26 ES |
91 | checked out in the new working tree, if it's not checked out anywhere |
92 | else, otherwise the command will refuse to create the working tree (unless | |
f60a7b76 | 93 | `--force` is used). |
fc56361f | 94 | |
bb9c03b8 MR |
95 | list:: |
96 | ||
4f375b26 ES |
97 | List details of each working tree. The main working tree is listed first, |
98 | followed by each of the linked working trees. The output details include | |
c57b3367 RS |
99 | whether the working tree is bare, the revision currently checked out, the |
100 | branch currently checked out (or "detached HEAD" if none), and "locked" if | |
101 | the worktree is locked. | |
bb9c03b8 | 102 | |
58142c09 NTND |
103 | lock:: |
104 | ||
105 | If a working tree is on a portable device or network share which | |
106 | is not always mounted, lock it to prevent its administrative | |
107 | files from being pruned automatically. This also prevents it from | |
108 | being moved or deleted. Optionally, specify a reason for the lock | |
109 | with `--reason`. | |
110 | ||
9f792bb4 NTND |
111 | move:: |
112 | ||
113 | Move a working tree to a new location. Note that the main working tree | |
bdd1f3e4 ES |
114 | or linked working trees containing submodules cannot be moved with this |
115 | command. (The `git worktree repair` command, however, can reestablish | |
116 | the connection with linked working trees if you move the main working | |
117 | tree manually.) | |
9f792bb4 | 118 | |
7b722d90 NTND |
119 | prune:: |
120 | ||
e79e313c | 121 | Prune working tree information in `$GIT_DIR/worktrees`. |
7b722d90 | 122 | |
cc73385c NTND |
123 | remove:: |
124 | ||
125 | Remove a working tree. Only clean working trees (no untracked files | |
126 | and no modification in tracked files) can be removed. Unclean working | |
127 | trees or ones with submodules can be removed with `--force`. The main | |
128 | working tree cannot be removed. | |
129 | ||
b214ab5a | 130 | repair [<path>...]:: |
e8e1ff24 ES |
131 | |
132 | Repair working tree administrative files, if possible, if they have | |
133 | become corrupted or outdated due to external factors. | |
bdd1f3e4 ES |
134 | + |
135 | For instance, if the main working tree (or bare repository) is moved, | |
136 | linked working trees will be unable to locate it. Running `repair` in | |
137 | the main working tree will reestablish the connection from linked | |
138 | working trees back to the main working tree. | |
b214ab5a ES |
139 | + |
140 | Similarly, if a linked working tree is moved without using `git worktree | |
141 | move`, the main working tree (or bare repository) will be unable to | |
142 | locate it. Running `repair` within the recently-moved working tree will | |
143 | reestablish the connection. If multiple linked working trees are moved, | |
144 | running `repair` from any working tree with each tree's new `<path>` as | |
145 | an argument, will reestablish the connection to all the specified paths. | |
e8e1ff24 | 146 | |
6d308627 NTND |
147 | unlock:: |
148 | ||
149 | Unlock a working tree, allowing it to be pruned, moved or deleted. | |
150 | ||
df0b6cfb NTND |
151 | OPTIONS |
152 | ------- | |
153 | ||
f4325444 ES |
154 | -f:: |
155 | --force:: | |
cc73385c NTND |
156 | By default, `add` refuses to create a new working tree when |
157 | `<commit-ish>` is a branch name and is already checked out by | |
e19831c9 ES |
158 | another working tree, or if `<path>` is already assigned to some |
159 | working tree but is missing (for instance, if `<path>` was deleted | |
160 | manually). This option overrides these safeguards. To add a missing but | |
161 | locked working tree path, specify `--force` twice. | |
162 | + | |
68a6b3a1 | 163 | `move` refuses to move a locked working tree unless `--force` is specified |
810382ed ES |
164 | twice. If the destination is already assigned to some other working tree but is |
165 | missing (for instance, if `<new-path>` was deleted manually), then `--force` | |
e79e313c | 166 | allows the move to proceed; use `--force` twice if the destination is locked. |
68a6b3a1 | 167 | + |
e19831c9 | 168 | `remove` refuses to remove an unclean working tree unless `--force` is used. |
f4143101 | 169 | To remove a locked working tree, specify `--force` twice. |
f4325444 | 170 | |
cbdf60fa ES |
171 | -b <new-branch>:: |
172 | -B <new-branch>:: | |
173 | With `add`, create a new branch named `<new-branch>` starting at | |
c4738aed | 174 | `<commit-ish>`, and check out `<new-branch>` into the new working tree. |
e79e313c | 175 | If `<commit-ish>` is omitted, it defaults to `HEAD`. |
cbdf60fa ES |
176 | By default, `-b` refuses to create a new branch if it already |
177 | exists. `-B` overrides this safeguard, resetting `<new-branch>` to | |
c4738aed | 178 | `<commit-ish>`. |
cbdf60fa | 179 | |
c670aa47 | 180 | -d:: |
39ecb274 | 181 | --detach:: |
e79e313c | 182 | With `add`, detach `HEAD` in the new working tree. See "DETACHED HEAD" |
bc483285 | 183 | in linkgit:git-checkout[1]. |
39ecb274 | 184 | |
ef2a0ac9 | 185 | --[no-]checkout:: |
c4738aed | 186 | By default, `add` checks out `<commit-ish>`, however, `--no-checkout` can |
ef2a0ac9 RZ |
187 | be used to suppress checkout in order to make customizations, |
188 | such as configuring sparse-checkout. See "Sparse checkout" | |
189 | in linkgit:git-read-tree[1]. | |
190 | ||
71d6682d TG |
191 | --[no-]guess-remote:: |
192 | With `worktree add <path>`, without `<commit-ish>`, instead | |
e79e313c | 193 | of creating a new branch from `HEAD`, if there exists a tracking |
50fdf7b1 | 194 | branch in exactly one remote matching the basename of `<path>`, |
71d6682d TG |
195 | base the new branch on the remote-tracking branch, and mark |
196 | the remote-tracking branch as "upstream" from the new branch. | |
e92445a7 TG |
197 | + |
198 | This can also be set up as the default behaviour by using the | |
199 | `worktree.guessRemote` config option. | |
71d6682d | 200 | |
e284e892 TG |
201 | --[no-]track:: |
202 | When creating a new branch, if `<commit-ish>` is a branch, | |
203 | mark it as "upstream" from the new branch. This is the | |
204 | default if `<commit-ish>` is a remote-tracking branch. See | |
e79e313c | 205 | `--track` in linkgit:git-branch[1] for details. |
e284e892 | 206 | |
507e6e9e NTND |
207 | --lock:: |
208 | Keep the working tree locked after creation. This is the | |
209 | equivalent of `git worktree lock` after `git worktree add`, | |
ff1ce500 | 210 | but without a race condition. |
507e6e9e | 211 | |
df0b6cfb NTND |
212 | -n:: |
213 | --dry-run:: | |
4f09825e | 214 | With `prune`, do not remove anything; just report what it would |
df0b6cfb NTND |
215 | remove. |
216 | ||
bb9c03b8 MR |
217 | --porcelain:: |
218 | With `list`, output in an easy-to-parse format for scripts. | |
219 | This format will remain stable across Git versions and regardless of user | |
220 | configuration. See below for details. | |
221 | ||
371979c2 EP |
222 | -q:: |
223 | --quiet:: | |
e79e313c | 224 | With `add`, suppress feedback messages. |
371979c2 | 225 | |
df0b6cfb NTND |
226 | -v:: |
227 | --verbose:: | |
4f09825e | 228 | With `prune`, report all removals. |
df0b6cfb NTND |
229 | |
230 | --expire <time>:: | |
e79e313c | 231 | With `prune`, only expire unused working trees older than `<time>`. |
df0b6cfb | 232 | |
58142c09 NTND |
233 | --reason <string>:: |
234 | With `lock`, an explanation why the working tree is locked. | |
235 | ||
236 | <worktree>:: | |
237 | Working trees can be identified by path, either relative or | |
238 | absolute. | |
080739ba NTND |
239 | + |
240 | If the last path components in the working tree's path is unique among | |
ff1ce500 | 241 | working trees, it can be used to identify a working tree. For example if |
e79e313c ES |
242 | you only have two working trees, at `/abc/def/ghi` and `/abc/def/ggg`, |
243 | then `ghi` or `def/ghi` is enough to point to the former working tree. | |
58142c09 | 244 | |
8aff1a9c NTND |
245 | REFS |
246 | ---- | |
247 | In multiple working trees, some refs may be shared between all working | |
ff1ce500 ES |
248 | trees and some refs are local. One example is `HEAD` which is different for each |
249 | working tree. This section is about the sharing rules and how to access | |
3a3b9d8c | 250 | refs of one working tree from another. |
8aff1a9c NTND |
251 | |
252 | In general, all pseudo refs are per working tree and all refs starting | |
e79e313c | 253 | with `refs/` are shared. Pseudo refs are ones like `HEAD` which are |
ff1ce500 ES |
254 | directly under `$GIT_DIR` instead of inside `$GIT_DIR/refs`. There are |
255 | exceptions, however: refs inside `refs/bisect` and `refs/worktree` are not | |
8aff1a9c NTND |
256 | shared. |
257 | ||
3a3b9d8c | 258 | Refs that are per working tree can still be accessed from another |
e79e313c | 259 | working tree via two special paths, `main-worktree` and `worktrees`. The |
4f375b26 | 260 | former gives access to per-working tree refs of the main working tree, |
3a3b9d8c NTND |
261 | while the latter to all linked working trees. |
262 | ||
e79e313c ES |
263 | For example, `main-worktree/HEAD` or `main-worktree/refs/bisect/good` |
264 | resolve to the same value as the main working tree's `HEAD` and | |
265 | `refs/bisect/good` respectively. Similarly, `worktrees/foo/HEAD` or | |
266 | `worktrees/bar/refs/bisect/bad` are the same as | |
267 | `$GIT_COMMON_DIR/worktrees/foo/HEAD` and | |
268 | `$GIT_COMMON_DIR/worktrees/bar/refs/bisect/bad`. | |
3a3b9d8c | 269 | |
e79e313c | 270 | To access refs, it's best not to look inside `$GIT_DIR` directly. Instead |
14f74d59 | 271 | use commands such as linkgit:git-rev-parse[1] or linkgit:git-update-ref[1] |
8aff1a9c NTND |
272 | which will handle refs correctly. |
273 | ||
58b284a2 NTND |
274 | CONFIGURATION FILE |
275 | ------------------ | |
e79e313c | 276 | By default, the repository `config` file is shared across all working |
58b284a2 NTND |
277 | trees. If the config variables `core.bare` or `core.worktree` are |
278 | already present in the config file, they will be applied to the main | |
279 | working trees only. | |
280 | ||
281 | In order to have configuration specific to working trees, you can turn | |
ff1ce500 | 282 | on the `worktreeConfig` extension, e.g.: |
58b284a2 NTND |
283 | |
284 | ------------ | |
285 | $ git config extensions.worktreeConfig true | |
286 | ------------ | |
287 | ||
288 | In this mode, specific configuration stays in the path pointed by `git | |
289 | rev-parse --git-path config.worktree`. You can add or update | |
290 | configuration in this file with `git config --worktree`. Older Git | |
291 | versions will refuse to access repositories with this extension. | |
292 | ||
293 | Note that in this file, the exception for `core.bare` and `core.worktree` | |
ff1ce500 | 294 | is gone. If they exist in `$GIT_DIR/config`, you must move |
58b284a2 NTND |
295 | them to the `config.worktree` of the main working tree. You may also |
296 | take this opportunity to review and move other configuration that you | |
297 | do not want to share to all working trees: | |
298 | ||
299 | - `core.worktree` and `core.bare` should never be shared | |
300 | ||
301 | - `core.sparseCheckout` is recommended per working tree, unless you | |
302 | are sure you always use sparse checkout for all working trees. | |
303 | ||
af189b4c ES |
304 | DETAILS |
305 | ------- | |
306 | Each linked working tree has a private sub-directory in the repository's | |
e79e313c | 307 | `$GIT_DIR/worktrees` directory. The private sub-directory's name is usually |
af189b4c ES |
308 | the base name of the linked working tree's path, possibly appended with a |
309 | number to make it unique. For example, when `$GIT_DIR=/path/main/.git` the | |
4d5a3c58 | 310 | command `git worktree add /path/other/test-next next` creates the linked |
af189b4c ES |
311 | working tree in `/path/other/test-next` and also creates a |
312 | `$GIT_DIR/worktrees/test-next` directory (or `$GIT_DIR/worktrees/test-next1` | |
313 | if `test-next` is already taken). | |
314 | ||
e79e313c | 315 | Within a linked working tree, `$GIT_DIR` is set to point to this private |
af189b4c | 316 | directory (e.g. `/path/main/.git/worktrees/test-next` in the example) and |
e79e313c | 317 | `$GIT_COMMON_DIR` is set to point back to the main working tree's `$GIT_DIR` |
af189b4c ES |
318 | (e.g. `/path/main/.git`). These settings are made in a `.git` file located at |
319 | the top directory of the linked working tree. | |
320 | ||
321 | Path resolution via `git rev-parse --git-path` uses either | |
e79e313c | 322 | `$GIT_DIR` or `$GIT_COMMON_DIR` depending on the path. For example, in the |
af189b4c ES |
323 | linked working tree `git rev-parse --git-path HEAD` returns |
324 | `/path/main/.git/worktrees/test-next/HEAD` (not | |
325 | `/path/other/test-next/.git/HEAD` or `/path/main/.git/HEAD`) while `git | |
326 | rev-parse --git-path refs/heads/master` uses | |
e79e313c ES |
327 | `$GIT_COMMON_DIR` and returns `/path/main/.git/refs/heads/master`, |
328 | since refs are shared across all working trees, except `refs/bisect` and | |
329 | `refs/worktree`. | |
af189b4c ES |
330 | |
331 | See linkgit:gitrepository-layout[5] for more information. The rule of | |
332 | thumb is do not make any assumption about whether a path belongs to | |
e79e313c ES |
333 | `$GIT_DIR` or `$GIT_COMMON_DIR` when you need to directly access something |
334 | inside `$GIT_DIR`. Use `git rev-parse --git-path` to get the final path. | |
af189b4c | 335 | |
e79e313c | 336 | If you manually move a linked working tree, you need to update the `gitdir` file |
618244e1 NTND |
337 | in the entry's directory. For example, if a linked working tree is moved |
338 | to `/newpath/test-next` and its `.git` file points to | |
339 | `/path/main/.git/worktrees/test-next`, then update | |
340 | `/path/main/.git/worktrees/test-next/gitdir` to reference `/newpath/test-next` | |
b214ab5a ES |
341 | instead. Better yet, run `git worktree repair` to reestablish the connection |
342 | automatically. | |
618244e1 | 343 | |
e79e313c | 344 | To prevent a `$GIT_DIR/worktrees` entry from being pruned (which |
a8ba5dd7 | 345 | can be useful in some situations, such as when the |
58142c09 NTND |
346 | entry's working tree is stored on a portable device), use the |
347 | `git worktree lock` command, which adds a file named | |
e79e313c | 348 | `locked` to the entry's directory. The file contains the reason in |
a8ba5dd7 ES |
349 | plain text. For example, if a linked working tree's `.git` file points |
350 | to `/path/main/.git/worktrees/test-next` then a file named | |
351 | `/path/main/.git/worktrees/test-next/locked` will prevent the | |
352 | `test-next` entry from being pruned. See | |
353 | linkgit:gitrepository-layout[5] for details. | |
354 | ||
e79e313c | 355 | When `extensions.worktreeConfig` is enabled, the config file |
58b284a2 | 356 | `.git/worktrees/<id>/config.worktree` is read after `.git/config` is. |
a8ba5dd7 | 357 | |
bb9c03b8 MR |
358 | LIST OUTPUT FORMAT |
359 | ------------------ | |
e79e313c | 360 | The `worktree list` command has two output formats. The default format shows the |
bb9c03b8 MR |
361 | details on a single line with columns. For example: |
362 | ||
363 | ------------ | |
22d11a6e | 364 | $ git worktree list |
bb9c03b8 MR |
365 | /path/to/bare-source (bare) |
366 | /path/to/linked-worktree abcd1234 [master] | |
367 | /path/to/other-linked-worktree 1234abc (detached HEAD) | |
368 | ------------ | |
369 | ||
370 | Porcelain Format | |
371 | ~~~~~~~~~~~~~~~~ | |
372 | The porcelain format has a line per attribute. Attributes are listed with a | |
e79e313c | 373 | label and value separated by a single space. Boolean attributes (like `bare` |
ff1ce500 | 374 | and `detached`) are listed as a label only, and are present only |
4f375b26 ES |
375 | if the value is true. The first attribute of a working tree is always |
376 | `worktree`, an empty line indicates the end of the record. For example: | |
bb9c03b8 MR |
377 | |
378 | ------------ | |
22d11a6e | 379 | $ git worktree list --porcelain |
bb9c03b8 MR |
380 | worktree /path/to/bare-source |
381 | bare | |
382 | ||
383 | worktree /path/to/linked-worktree | |
384 | HEAD abcd1234abcd1234abcd1234abcd1234abcd1234 | |
385 | branch refs/heads/master | |
386 | ||
387 | worktree /path/to/other-linked-worktree | |
388 | HEAD 1234abc1234abc1234abc1234abc1234abc1234a | |
389 | detached | |
390 | ||
391 | ------------ | |
392 | ||
96454597 ES |
393 | EXAMPLES |
394 | -------- | |
395 | You are in the middle of a refactoring session and your boss comes in and | |
396 | demands that you fix something immediately. You might typically use | |
397 | linkgit:git-stash[1] to store your changes away temporarily, however, your | |
bc483285 MH |
398 | working tree is in such a state of disarray (with new, moved, and removed |
399 | files, and other bits and pieces strewn around) that you don't want to risk | |
400 | disturbing any of it. Instead, you create a temporary linked working tree to | |
96454597 ES |
401 | make the emergency fix, remove it when done, and then resume your earlier |
402 | refactoring session. | |
403 | ||
404 | ------------ | |
cbdf60fa | 405 | $ git worktree add -b emergency-fix ../temp master |
96454597 ES |
406 | $ pushd ../temp |
407 | # ... hack hack hack ... | |
408 | $ git commit -a -m 'emergency fix for boss' | |
409 | $ popd | |
3f0b42bd | 410 | $ git worktree remove ../temp |
96454597 ES |
411 | ------------ |
412 | ||
6d3824cf ES |
413 | BUGS |
414 | ---- | |
18b22dbe JH |
415 | Multiple checkout in general is still experimental, and the support |
416 | for submodules is incomplete. It is NOT recommended to make multiple | |
417 | checkouts of a superproject. | |
6d3824cf | 418 | |
df0b6cfb NTND |
419 | GIT |
420 | --- | |
421 | Part of the linkgit:git[1] suite |