Documentation/git-worktree.txt

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