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] [-b <new-branch>] <path> [<branch>]
  13 'git worktree prune' [-n] [-v] [--expire <expire>]
  14 'git worktree list' [--porcelain]
  15
  16 DESCRIPTION
  17 -----------
  18
  19 Manage multiple working trees attached to the same repository.
  20
  21 A git repository can support multiple working trees, allowing you to check
  22 out more than one branch at a time.  With `git worktree add` a new working
  23 tree is associated with the repository.  This new working tree is called a
  24 "linked working tree" as opposed to the "main working tree" prepared by "git
  25 init" or "git clone".  A repository has one main working tree (if it's not a
  26 bare repository) and zero or more linked working trees.
  27
  28 When you are done with a linked working tree you can simply delete it.
  29 The working tree's administrative files in the repository (see
  30 "DETAILS" below) will eventually be removed automatically (see
  31 `gc.worktreePruneExpire` in linkgit:git-config[1]), or you can run
  32 `git worktree prune` in the main or any linked working tree to
  33 clean up any stale administrative files.
  34
  35 If you move a linked working tree, you need to manually update the
  36 administrative files so that they do not get pruned automatically. See
  37 section "DETAILS" for more information.
  38
  39 If a linked working tree is stored on a portable device or network share
  40 which is not always mounted, you can prevent its administrative files from
  41 being pruned by creating a file named 'locked' alongside the other
  42 administrative files, optionally containing a plain text reason that
  43 pruning should be suppressed. See section "DETAILS" for more information.
  44
  45 COMMANDS
  46 --------
  47 add <path> [<branch>]::
  48
  49 Create `<path>` and checkout `<branch>` 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.
  52 +
  53 If `<branch>` is omitted and neither `-b` nor `-B` nor `--detached` used,
  54 then, as a convenience, a new branch based at HEAD is created automatically,
  55 as if `-b $(basename <path>)` was specified.
  56
  57 prune::
  58
  59 Prune working tree information in $GIT_DIR/worktrees.
  60
  61 list::
  62
  63 List details of each worktree.  The main worktree is listed first, followed by
  64 each of the linked worktrees.  The output details include if the worktree is
  65 bare, the revision currently checked out, and the branch currently checked out
  66 (or 'detached HEAD' if none).
  67
  68 OPTIONS
  69 -------
  70
  71 -f::
  72 --force::
  73         By default, `add` refuses to create a new working tree when `<branch>`
  74         is already checked out by another working tree. This option overrides
  75         that safeguard.
  76
  77 -b <new-branch>::
  78 -B <new-branch>::
  79         With `add`, create a new branch named `<new-branch>` starting at
  80         `<branch>`, and check out `<new-branch>` into the new working tree.
  81         If `<branch>` is omitted, it defaults to HEAD.
  82         By default, `-b` refuses to create a new branch if it already
  83         exists. `-B` overrides this safeguard, resetting `<new-branch>` to
  84         `<branch>`.
  85
  86 --detach::
  87         With `add`, detach HEAD in the new working tree. See "DETACHED HEAD"
  88         in linkgit:git-checkout[1].
  89
  90 -n::
  91 --dry-run::
  92         With `prune`, do not remove anything; just report what it would
  93         remove.
  94
  95 --porcelain::
  96         With `list`, output in an easy-to-parse format for scripts.
  97         This format will remain stable across Git versions and regardless of user
  98         configuration.  See below for details.
  99
 100 -v::
 101 --verbose::
 102         With `prune`, report all removals.
 103
 104 --expire <time>::
 105         With `prune`, only expire unused working trees older than <time>.
 106
 107 DETAILS
 108 -------
 109 Each linked working tree has a private sub-directory in the repository's
 110 $GIT_DIR/worktrees directory.  The private sub-directory's name is usually
 111 the base name of the linked working tree's path, possibly appended with a
 112 number to make it unique.  For example, when `$GIT_DIR=/path/main/.git` the
 113 command `git worktree add /path/other/test-next next` creates the linked
 114 working tree in `/path/other/test-next` and also creates a
 115 `$GIT_DIR/worktrees/test-next` directory (or `$GIT_DIR/worktrees/test-next1`
 116 if `test-next` is already taken).
 117
 118 Within a linked working tree, $GIT_DIR is set to point to this private
 119 directory (e.g. `/path/main/.git/worktrees/test-next` in the example) and
 120 $GIT_COMMON_DIR is set to point back to the main working tree's $GIT_DIR
 121 (e.g. `/path/main/.git`). These settings are made in a `.git` file located at
 122 the top directory of the linked working tree.
 123
 124 Path resolution via `git rev-parse --git-path` uses either
 125 $GIT_DIR or $GIT_COMMON_DIR depending on the path. For example, in the
 126 linked working tree `git rev-parse --git-path HEAD` returns
 127 `/path/main/.git/worktrees/test-next/HEAD` (not
 128 `/path/other/test-next/.git/HEAD` or `/path/main/.git/HEAD`) while `git
 129 rev-parse --git-path refs/heads/master` uses
 130 $GIT_COMMON_DIR and returns `/path/main/.git/refs/heads/master`,
 131 since refs are shared across all working trees.
 132
 133 See linkgit:gitrepository-layout[5] for more information. The rule of
 134 thumb is do not make any assumption about whether a path belongs to
 135 $GIT_DIR or $GIT_COMMON_DIR when you need to directly access something
 136 inside $GIT_DIR. Use `git rev-parse --git-path` to get the final path.
 137
 138 If you move a linked working tree, you need to update the 'gitdir' file
 139 in the entry's directory. For example, if a linked working tree is moved
 140 to `/newpath/test-next` and its `.git` file points to
 141 `/path/main/.git/worktrees/test-next`, then update
 142 `/path/main/.git/worktrees/test-next/gitdir` to reference `/newpath/test-next`
 143 instead.
 144
 145 To prevent a $GIT_DIR/worktrees entry from being pruned (which
 146 can be useful in some situations, such as when the
 147 entry's working tree is stored on a portable device), add a file named
 148 'locked' to the entry's directory. The file contains the reason in
 149 plain text. For example, if a linked working tree's `.git` file points
 150 to `/path/main/.git/worktrees/test-next` then a file named
 151 `/path/main/.git/worktrees/test-next/locked` will prevent the
 152 `test-next` entry from being pruned.  See
 153 linkgit:gitrepository-layout[5] for details.
 154
 155 LIST OUTPUT FORMAT
 156 ------------------
 157 The worktree list command has two output formats.  The default format shows the
 158 details on a single line with columns.  For example:
 159
 160 ------------
 161 S git worktree list
 162 /path/to/bare-source            (bare)
 163 /path/to/linked-worktree        abcd1234 [master]
 164 /path/to/other-linked-worktree  1234abc  (detached HEAD)
 165 ------------
 166
 167 Porcelain Format
 168 ~~~~~~~~~~~~~~~~
 169 The porcelain format has a line per attribute.  Attributes are listed with a
 170 label and value separated by a single space.  Boolean attributes (like 'bare'
 171 and 'detached') are listed as a label only, and are only present if and only
 172 if the value is true.  An empty line indicates the end of a worktree.  For
 173 example:
 174
 175 ------------
 176 S git worktree list --porcelain
 177 worktree /path/to/bare-source
 178 bare
 179
 180 worktree /path/to/linked-worktree
 181 HEAD abcd1234abcd1234abcd1234abcd1234abcd1234
 182 branch refs/heads/master
 183
 184 worktree /path/to/other-linked-worktree
 185 HEAD 1234abc1234abc1234abc1234abc1234abc1234a
 186 detached
 187
 188 ------------
 189
 190 EXAMPLES
 191 --------
 192 You are in the middle of a refactoring session and your boss comes in and
 193 demands that you fix something immediately. You might typically use
 194 linkgit:git-stash[1] to store your changes away temporarily, however, your
 195 working tree is in such a state of disarray (with new, moved, and removed
 196 files, and other bits and pieces strewn around) that you don't want to risk
 197 disturbing any of it. Instead, you create a temporary linked working tree to
 198 make the emergency fix, remove it when done, and then resume your earlier
 199 refactoring session.
 200
 201 ------------
 202 $ git worktree add -b emergency-fix ../temp master
 203 $ pushd ../temp
 204 # ... hack hack hack ...
 205 $ git commit -a -m 'emergency fix for boss'
 206 $ popd
 207 $ rm -rf ../temp
 208 $ git worktree prune
 209 ------------
 210
 211 BUGS
 212 ----
 213 Multiple checkout in general is still experimental, and the support
 214 for submodules is incomplete. It is NOT recommended to make multiple
 215 checkouts of a superproject.
 216
 217 git-worktree could provide more automation for tasks currently
 218 performed manually, such as:
 219
 220 - `remove` to remove a linked working tree and its administrative files (and
 221   warn if the working tree is dirty)
 222 - `mv` to move or rename a working tree and update its administrative files
 223 - `lock` to prevent automatic pruning of administrative files (for instance,
 224   for a working tree on a portable device)
 225
 226 GIT
 227 ---
 228 Part of the linkgit:git[1] suite