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