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